jekyll-theme-open-project 1.1.27 → 1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -5
- data/_includes/_nav-item.html +33 -0
- data/_includes/item-doc-page.html +53 -96
- data/_includes/item-external-links.html +6 -6
- data/_includes/project-doc-page.html +0 -70
- data/_layouts/default.html +1 -0
- data/_layouts/docs-base.html +74 -0
- data/_layouts/product.html +1 -0
- data/_sass/headroom.scss +2 -2
- data/_sass/jekyll-theme-open-project.scss +2 -6
- data/_sass/open-project-base.scss +5 -4
- data/_sass/open-project-header-footer.scss +1 -0
- data/_sass/open-project-mixins.scss +305 -255
- data/assets/js/opf.js +36 -51
- metadata +6 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: eff8fded69928516a4760e368278fe22d4ffa118ee215a83886b3e5932172537
|
|
4
|
+
data.tar.gz: d8721bb216aa04aa8a3fc05bb6557787c2471bed56ae4fc5b2766cbf17fb5dec
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 1142e54262a3be29436e02df0882d15e15731fec24c047430663dc1f8411d8ebd9d5f0d4385e83795f41178ebd04c5eba213dd7b9b866a66fe798b80ebd4d6f3
|
|
7
|
+
data.tar.gz: 45ec5860de2593bf5cb399fe167b5eeff4e2de64bc3eab76408e34160046577070f2feabb4a46a6bb578475c20422d7dc158b5d493723e78cbe01a516ecf1219
|
data/README.md
CHANGED
|
@@ -456,18 +456,18 @@ in above sample, place a file called `navigation.md` containing
|
|
|
456
456
|
only frontmatter, following this sample:
|
|
457
457
|
|
|
458
458
|
```yaml
|
|
459
|
-
|
|
459
|
+
items:
|
|
460
460
|
- name: Introduction
|
|
461
461
|
items:
|
|
462
|
-
- overview
|
|
463
|
-
- installation
|
|
462
|
+
- { title: Overview, path: overview/ }
|
|
463
|
+
- { title: Installation, path: installation/ }
|
|
464
464
|
- name: Usage
|
|
465
465
|
items:
|
|
466
|
-
- basic
|
|
466
|
+
- { title: Basic, path: basic-usage/ }
|
|
467
467
|
```
|
|
468
468
|
|
|
469
469
|
In the same directory, place the required document pages—in this case, `overview.md`,
|
|
470
|
-
`installation.md`, and `basic.md`. Each
|
|
470
|
+
`installation.md`, and `basic-usage.md`. Each file must contain
|
|
471
471
|
standard YAML frontmatter with at least `title` specified.
|
|
472
472
|
|
|
473
473
|
During project site build, Jekyll pulls docs for software that’s part of the
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{% assign base_url = include.base_url | default: "" %}
|
|
2
|
+
{% assign link = base_url | append: include.item.path %}
|
|
3
|
+
|
|
4
|
+
{% if include.item == include.selected_item %}
|
|
5
|
+
{% assign selected = true %}
|
|
6
|
+
{% elsif include.selected_item == null and page.url == link %}
|
|
7
|
+
{% assign selected = true %}
|
|
8
|
+
{% else %}
|
|
9
|
+
{% assign selected = false %}
|
|
10
|
+
{% comment %} Otherwise in Liquid selected value falls through to next include instance {% endcomment %}
|
|
11
|
+
{% endif %}
|
|
12
|
+
|
|
13
|
+
<li class="item {% if selected %}selected{% endif %}">
|
|
14
|
+
<div class="item-title">
|
|
15
|
+
{% if include.item.path == null or selected == true %}
|
|
16
|
+
<span>
|
|
17
|
+
{{ include.item.title }}
|
|
18
|
+
</span>
|
|
19
|
+
{% else %}
|
|
20
|
+
<a href="{{ link }}">
|
|
21
|
+
{{ include.item.title }}
|
|
22
|
+
</a>
|
|
23
|
+
{% endif %}
|
|
24
|
+
</div>
|
|
25
|
+
|
|
26
|
+
{% if include.item.items %}
|
|
27
|
+
<ul class="nav-items subitmes">
|
|
28
|
+
{% for item in include.item.items %}
|
|
29
|
+
{% include _nav-item.html item=item base_url=include.base_url selected_item=include.selected_item %}
|
|
30
|
+
{% endfor %}
|
|
31
|
+
</ul>
|
|
32
|
+
{% endif %}
|
|
33
|
+
</li>
|
|
@@ -1,104 +1,61 @@
|
|
|
1
1
|
{% assign product_base_url = page.url | split: "/" | slice: 0, 3 | join: "/" | append: "/" %}
|
|
2
|
+
{% assign docs_base_url = product_base_url | append: "docs/" %}
|
|
3
|
+
|
|
2
4
|
{% if page.url == product_base_url %}
|
|
3
5
|
{% assign is_docs_landing = true %}
|
|
4
6
|
{% else %}
|
|
5
7
|
{% assign is_docs_landing = false %}
|
|
6
8
|
{% endif %}
|
|
7
9
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
10
|
+
{% assign docs_base_url = product_base_url | append: "docs/" %}
|
|
11
|
+
{% assign item_docs = include.items | where_exp: "item", "item.url contains docs_base_url" %}
|
|
12
|
+
{% assign nav = item_docs | where_exp: "item", "item.path contains 'docs/navigation'" | first %}
|
|
13
|
+
{% assign item_data = include.items | where_exp: "item", "item.url == product_base_url" | first %}
|
|
12
14
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
15
|
+
{% if nav == nil %}
|
|
16
|
+
{% assign nav = page.navigation || layout.navigation %}
|
|
17
|
+
{% endif %}
|
|
16
18
|
|
|
17
|
-
|
|
19
|
+
{% if is_docs_landing != true %}
|
|
20
|
+
<header class="documentation-header">
|
|
21
|
+
<span class="section-title">
|
|
22
|
+
{{ page.title|replace: " ", " " }}
|
|
23
|
+
</span>
|
|
18
24
|
|
|
19
|
-
|
|
25
|
+
<div class="nav-header">
|
|
26
|
+
{% if include.item_type == 'software' %}
|
|
27
|
+
<div class="logo-container">
|
|
28
|
+
{% include software-symbol.html item_id=page.id %}
|
|
29
|
+
</div>
|
|
30
|
+
{% endif %}
|
|
20
31
|
|
|
21
|
-
|
|
32
|
+
<h3 class="title">
|
|
33
|
+
<a href="{{ product_base_url | relative_url }}">{{ item_data.title }}</a>
|
|
34
|
+
</h3>
|
|
22
35
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
<h3 class="title">
|
|
31
|
-
<a href="{{ product_base_url | relative_url }}">{{ item_data.title }}</a>
|
|
32
|
-
</h3>
|
|
33
|
-
<span class="section-title">
|
|
34
|
-
→ {{ page.title|replace: " ", " " }}
|
|
35
|
-
</span>
|
|
36
|
-
</header>
|
|
37
|
-
|
|
38
|
-
<section class="external-links">
|
|
39
|
-
{% include item-external-links.html item_type=include.item_type item_data=item_data %}
|
|
40
|
-
</section>
|
|
41
|
-
|
|
42
|
-
{% elsif num_nav_sections > 0 and include.item_type == 'software' %}
|
|
43
|
-
<header class="sidebar-header">
|
|
44
|
-
<h3 class="title">
|
|
45
|
-
Documentation
|
|
46
|
-
</h3>
|
|
47
|
-
</header>
|
|
48
|
-
{% endif %}
|
|
36
|
+
<span class="nav-toggle-icon">
|
|
37
|
+
<i class="open far fa-ellipsis-v"></i>
|
|
38
|
+
<i class="close far fa-times"></i>
|
|
39
|
+
</span>
|
|
40
|
+
</div>
|
|
41
|
+
</header>
|
|
42
|
+
{% endif %}
|
|
49
43
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
{% assign linked_page = include.items | where_exp: "item", "item.url contains link" | first %}
|
|
66
|
-
|
|
67
|
-
{% if item.title %}
|
|
68
|
-
{% assign item_title = item.title %}
|
|
69
|
-
{% elsif item.ignore_missing != true %}
|
|
70
|
-
{% assign item_title = linked_page.title %}
|
|
71
|
-
{% endif %}
|
|
72
|
-
|
|
73
|
-
{% if linked_page or item.ignore_missing %}
|
|
74
|
-
{% if page.url != link %}
|
|
75
|
-
<li class="item">
|
|
76
|
-
<a href="{{ link | relative_url }}">
|
|
77
|
-
{{ item_title }}
|
|
78
|
-
</a>
|
|
79
|
-
{% else %}
|
|
80
|
-
<li class="item selected">
|
|
81
|
-
<span>
|
|
82
|
-
{{ item_title }}
|
|
83
|
-
</span>
|
|
84
|
-
{% endif %}
|
|
85
|
-
{% else %}
|
|
86
|
-
<li class="item">
|
|
87
|
-
<span class="tbd">
|
|
88
|
-
{% if item.title %}
|
|
89
|
-
{{ item.title }}
|
|
90
|
-
{% else %}
|
|
91
|
-
{{ item }}
|
|
92
|
-
{% endif %}
|
|
93
|
-
</span>
|
|
94
|
-
{% endif %}
|
|
95
|
-
|
|
96
|
-
{% assign link = "" %}
|
|
97
|
-
{% endfor %}
|
|
98
|
-
</ul>
|
|
99
|
-
</section>
|
|
100
|
-
{% endfor %}
|
|
101
|
-
</nav>
|
|
44
|
+
<section class="documentation {% if is_docs_landing %}docs-landing{% endif %} {{ include.item_type }}">
|
|
45
|
+
|
|
46
|
+
{% if is_docs_landing == false %}
|
|
47
|
+
<nav class="docs-nav">
|
|
48
|
+
<ul class="nav-items">
|
|
49
|
+
<li class="item external-links">
|
|
50
|
+
{% include item-external-links.html item_type=include.item_type item_data=item_data %}
|
|
51
|
+
</li>
|
|
52
|
+
|
|
53
|
+
{% for item in nav.items %}
|
|
54
|
+
{% include _nav-item.html item=item base_url=docs_base_url %}
|
|
55
|
+
{% endfor %}
|
|
56
|
+
</ul>
|
|
57
|
+
</nav>
|
|
58
|
+
{% endif %}
|
|
102
59
|
|
|
103
60
|
<article>
|
|
104
61
|
<header>
|
|
@@ -114,7 +71,7 @@
|
|
|
114
71
|
|
|
115
72
|
{% if is_docs_landing == false and item_data.docs.git_repo_url %}
|
|
116
73
|
<nav>
|
|
117
|
-
<button class="docs-nav-toggle">
|
|
74
|
+
<button class="docs-nav-toggle">Toggle table of contents</button>
|
|
118
75
|
<a href="{{ item_data.docs.git_repo_url }}/edit/master/docs/{{ page.path | split: "/" | last }}" class="docs-suggest-edits">Suggest edits to this page</a>
|
|
119
76
|
</nav>
|
|
120
77
|
{% endif %}
|
|
@@ -134,13 +91,13 @@
|
|
|
134
91
|
{{ content }}
|
|
135
92
|
</div>
|
|
136
93
|
|
|
137
|
-
{%
|
|
138
|
-
|
|
139
|
-
<nav>
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
94
|
+
{% assign nav_size = nav.items | size %}
|
|
95
|
+
{% if is_docs_landing and nav_size > 0 %}
|
|
96
|
+
<ul class="nav-items">
|
|
97
|
+
{% for item in nav.items %}
|
|
98
|
+
{% include _nav-item.html item=item base_url=docs_base_url %}
|
|
99
|
+
{% endfor %}
|
|
100
|
+
</ul>
|
|
144
101
|
{% endif %}
|
|
145
102
|
|
|
146
103
|
</article>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{% if include.item_type == 'software' and item_data.repo_url or item_data.docs_url %}
|
|
2
|
-
<ul class="
|
|
2
|
+
<ul class="nav-items">
|
|
3
3
|
{% if item_data.repo_url %}
|
|
4
4
|
<li class="item">
|
|
5
5
|
<a href="{{ item_data.repo_url }}">
|
|
@@ -8,14 +8,14 @@
|
|
|
8
8
|
<i class="fab fa-github"></i>
|
|
9
9
|
</span>
|
|
10
10
|
<span class="lbl">
|
|
11
|
-
GitHub
|
|
11
|
+
GitHub
|
|
12
12
|
</span>
|
|
13
13
|
{% else %}
|
|
14
14
|
<span class="ico">
|
|
15
15
|
<i class="far fa-code"></i>
|
|
16
16
|
</span>
|
|
17
17
|
<span class="lbl">
|
|
18
|
-
Source
|
|
18
|
+
Source Code
|
|
19
19
|
</span>
|
|
20
20
|
{% endif %}
|
|
21
21
|
</a> {% endif %}
|
|
@@ -27,21 +27,21 @@
|
|
|
27
27
|
<i class="far fa-gem"></i>
|
|
28
28
|
</span>
|
|
29
29
|
<span class="lbl">
|
|
30
|
-
|
|
30
|
+
RubyDocs
|
|
31
31
|
</span>
|
|
32
32
|
{% else if item_data.docs_url contains "docs.rs" %}
|
|
33
33
|
<span class="ico">
|
|
34
34
|
<i class="far fa-book"></i>
|
|
35
35
|
</span>
|
|
36
36
|
<span class="lbl">
|
|
37
|
-
|
|
37
|
+
Docs.rs
|
|
38
38
|
</span>
|
|
39
39
|
{% else %}
|
|
40
40
|
<span class="ico">
|
|
41
41
|
<i class="far fa-book"></i>
|
|
42
42
|
</span>
|
|
43
43
|
<span class="lbl">
|
|
44
|
-
|
|
44
|
+
Docs
|
|
45
45
|
</span>
|
|
46
46
|
{% endif %}
|
|
47
47
|
</a> {% endif %}
|
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
{% assign product_base_url = "/docs/" %}
|
|
2
|
-
|
|
3
|
-
<section class="documentation {{ page.html-class }}">
|
|
4
|
-
{% assign nav = page.navigation | default: layout.navigation %}
|
|
5
|
-
{% assign num_nav_sections = nav.sections | size %}
|
|
6
|
-
|
|
7
|
-
<nav class="docs-nav">
|
|
8
|
-
|
|
9
|
-
<header class="sidebar-header">
|
|
10
|
-
<h3 class="title">
|
|
11
|
-
<a href="javascript: void 0;">{{ include.header_main }}</a>
|
|
12
|
-
</h3>
|
|
13
|
-
|
|
14
|
-
{% if include.header_side %}
|
|
15
|
-
<span class="section-title">
|
|
16
|
-
→ {{ include.header_side|replace: " ", " " }}
|
|
17
|
-
</span>
|
|
18
|
-
{% endif %}
|
|
19
|
-
</header>
|
|
20
|
-
|
|
21
|
-
{% for section in nav.sections %}
|
|
22
|
-
<section>
|
|
23
|
-
<h4 class="section-title">{{ section.name }}</h4>
|
|
24
|
-
<ul class="section-items">
|
|
25
|
-
{% for item in section.items %}
|
|
26
|
-
{% assign item_path = item.path %}
|
|
27
|
-
{% assign link = product_base_url | append: item_path %}
|
|
28
|
-
|
|
29
|
-
{% if page.url != link %}
|
|
30
|
-
<li class="item">
|
|
31
|
-
<a href="{{ link }}">
|
|
32
|
-
{{ item.title }}
|
|
33
|
-
</a>
|
|
34
|
-
{% else %}
|
|
35
|
-
<li class="item selected">
|
|
36
|
-
<span>
|
|
37
|
-
{{ item.title }}
|
|
38
|
-
</span>
|
|
39
|
-
{% endif %}
|
|
40
|
-
|
|
41
|
-
{% assign link = "" %}
|
|
42
|
-
{% endfor %}
|
|
43
|
-
</ul>
|
|
44
|
-
</section>
|
|
45
|
-
{% endfor %}
|
|
46
|
-
</nav>
|
|
47
|
-
|
|
48
|
-
<article>
|
|
49
|
-
<header>
|
|
50
|
-
<div class="title">
|
|
51
|
-
{% if include.item_type == 'software' and page.url == product_base_url %}
|
|
52
|
-
<div class="logo-container">
|
|
53
|
-
{% include software-symbol.html item_id=page.id %}
|
|
54
|
-
</div>
|
|
55
|
-
{% endif %}
|
|
56
|
-
|
|
57
|
-
<h1 class="text">{{ page.article_header_title | default: page.title }}</h1>
|
|
58
|
-
</div>
|
|
59
|
-
|
|
60
|
-
<div>
|
|
61
|
-
<h3 class="lead">{{ page.description }}</h3>
|
|
62
|
-
</div>
|
|
63
|
-
</header>
|
|
64
|
-
|
|
65
|
-
<div class="body">
|
|
66
|
-
{{ content }}
|
|
67
|
-
</div>
|
|
68
|
-
|
|
69
|
-
</article>
|
|
70
|
-
</section>
|
data/_layouts/default.html
CHANGED
|
@@ -32,6 +32,7 @@
|
|
|
32
32
|
|
|
33
33
|
{% assign num_projects = site.projects | size %}
|
|
34
34
|
<body class="
|
|
35
|
+
{{ page.html-class }} {{ layout.html-class }}
|
|
35
36
|
{% if num_projects > 0 %}site--hub{% else %}site--project{% endif %}
|
|
36
37
|
{% if page.layout %}layout--{{ page.layout }}{% endif %}">
|
|
37
38
|
<div class="underlay header">
|
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
---
|
|
2
|
+
layout: default
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
{% assign nav = page.navigation | default: layout.navigation %}
|
|
6
|
+
{% assign num_nav_sections = nav.sections | size %}
|
|
7
|
+
|
|
8
|
+
{% for item in nav.items %}
|
|
9
|
+
{% assign topmost_item = item %}
|
|
10
|
+
|
|
11
|
+
{% if page.url == item.path %}
|
|
12
|
+
{% assign selected_item = item %}
|
|
13
|
+
{% assign selected_section = item %}
|
|
14
|
+
{% endif %}
|
|
15
|
+
|
|
16
|
+
{% if item.items %}
|
|
17
|
+
{% for item in item.items %}
|
|
18
|
+
{% if page.url == item.path %}
|
|
19
|
+
{% assign selected_item = item %}
|
|
20
|
+
{% assign selected_section = topmost_item %}
|
|
21
|
+
{% endif %}
|
|
22
|
+
{% endfor %}
|
|
23
|
+
{% endif %}
|
|
24
|
+
{% endfor %}
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
<header class="documentation-header">
|
|
28
|
+
{% if page.title %}
|
|
29
|
+
<span class="section-title">
|
|
30
|
+
{{ page.title|replace: " ", " " }}
|
|
31
|
+
</span>
|
|
32
|
+
{% endif %}
|
|
33
|
+
|
|
34
|
+
<div class="nav-header">
|
|
35
|
+
<h3 class="title">
|
|
36
|
+
<a href="javascript: void 0;">
|
|
37
|
+
{{ layout.docs_title }}{% if selected_section %}: {{ selected_section.title }}{% endif %}
|
|
38
|
+
</a>
|
|
39
|
+
</h3>
|
|
40
|
+
|
|
41
|
+
<span class="nav-toggle-icon">
|
|
42
|
+
<i class="open far fa-ellipsis-v"></i>
|
|
43
|
+
<i class="close far fa-times"></i>
|
|
44
|
+
</span>
|
|
45
|
+
</div>
|
|
46
|
+
</header>
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
<section class="documentation {{ page.html-class }}">
|
|
50
|
+
<nav class="docs-nav">
|
|
51
|
+
<ul class="nav-items">
|
|
52
|
+
{% for item in nav.items %}
|
|
53
|
+
{% include _nav-item.html selected_item=selected_item item=item %}
|
|
54
|
+
{% endfor %}
|
|
55
|
+
</ul>
|
|
56
|
+
</nav>
|
|
57
|
+
|
|
58
|
+
<article>
|
|
59
|
+
<header>
|
|
60
|
+
<div class="title">
|
|
61
|
+
<h1 class="text">{{ page.article_header_title | default: page.title }}</h1>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<div>
|
|
65
|
+
<h3 class="lead">{{ page.description }}</h3>
|
|
66
|
+
</div>
|
|
67
|
+
</header>
|
|
68
|
+
|
|
69
|
+
<div class="body">
|
|
70
|
+
{{ content }}
|
|
71
|
+
</div>
|
|
72
|
+
|
|
73
|
+
</article>
|
|
74
|
+
</section>
|