just-the-docs 0.4.0.rc3 → 0.4.0.rc4

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4ea3b0ea21a727723756d2d947483604eba31765e1cf40aecec9370cc87a3f90
4
- data.tar.gz: 1aa63df6cd1a17be4f37d2c3f7a6058f57c7c462ac857dc087c7aa41db406a1f
3
+ metadata.gz: c8877f9fb409c496769e604fa5c53121d72234e51e7d76aed6d243588ffb8544
4
+ data.tar.gz: 205a1e33b36fd961b3a8c429ba4f660a367c0272a00143888a5244e6f896e875
5
5
  SHA512:
6
- metadata.gz: defb8f100d04b9d497e20fd6c8fd5e29ef092a95362f85d453eafdffc17177d3e7b602c785da6e11106bbe5a4abee8ef242d6ff63251cdd7502c02a106c5c178
7
- data.tar.gz: 0ad188da9252379f41175089cbd53da0b10075c5e5057cbc2ebc26dfa8a7072e4d7f467b963eca03696b4f86ff40f3cb180149c63101fa4e0515611d50605d13
6
+ metadata.gz: 0422f4278093a39c11a7aeb437e9ccee7b7a738f706a764a61e102e456165cb78b6d0992c27ce27a74e83d99d39507fdb06cb6ee94835f9fe66b8678fa504b1a
7
+ data.tar.gz: 47a66cab38cc77f7ed3cd839bc5eb93401a715639ee7c57b48418c9221c22851095812abd83ba2daaaba0097a5e8cfc97bb227cb39c3aa85618080d602757c0a
data/CHANGELOG.md CHANGED
@@ -5,7 +5,7 @@ layout: default
5
5
 
6
6
  # CHANGELOG
7
7
 
8
- All notable changes to this project are documented in this file.
8
+ All notable user-facing changes to this project are documented in this file.
9
9
 
10
10
  {: .highlight }
11
11
  The project underwent a major maintenance shift in March 2022.
@@ -16,11 +16,141 @@ The project underwent a major maintenance shift in March 2022.
16
16
  This website is built from the `HEAD` of the `main` branch of the theme repository.
17
17
 
18
18
  {: .warning }
19
- This website includes docs for some new features that are not available in `v0.4.0.rc2` and `v0.3.3`!
19
+ This website includes docs for some new features that are not available in `v0.4.0.rc4` and `v0.3.3`!
20
20
 
21
21
  Changes to `main` that are *not* in the latest pre-release:
22
22
 
23
- - N/A
23
+ - n/a
24
+
25
+ ## Pre-release v0.4.0.rc4
26
+
27
+ Happy new year! We're celebrating with another pre-release, with features that should help theme users better adapt to changes moving forward. **We aim to re-release this as `v0.4.0`, with only few changes**.
28
+
29
+ Notable new additions include:
30
+
31
+ - modular site components, which split up the site into smaller reusable components; advanced theme users can then remix layouts quickly without duplication
32
+ - a "copy code" button to code blocks
33
+ - fixing bugs in generated TOCs and navigation from previous prereleases
34
+ - various cleanups of CSS and HTML markup
35
+
36
+ The roadmap to `v0.4.0` is small. We are only looking to:
37
+
38
+ - finish a migration guide, so users can easily upgrade from `v0.3.3` to `v0.4.0`
39
+ - fix one last bug relating to callouts and custom colors
40
+ - fix any new bugs introduced by this pre-release
41
+
42
+ Have any questions, thoughts, or concerns? We'd love to hear from you! Please [open an issue](https://github.com/just-the-docs/just-the-docs/issues) or [start a discussion](https://github.com/just-the-docs/just-the-docs/discussions) and let us know!
43
+
44
+ ### Trying out pre-release `v0.4.0.rc4`
45
+
46
+ Simlar to the prior release, `v0.4.0.rc4` is a **release candidate** for the theme (i.e., a pre-release) with release `v0.4.0` coming soon. We want your help in testing the changes! As of now, the gem on RubyGems and the repository are updated to `v0.4.0.rc4`.
47
+
48
+ To use this RC explicitly as a remote theme:
49
+
50
+ ```yml
51
+ remote_theme: just-the-docs/just-the-docs@v0.4.0.rc4
52
+ ```
53
+
54
+ To use this RC explicitly as a gem-based theme, pin the version in your `Gemfile` and re-run `bundle install` or `bundle update just-the-docs`:
55
+
56
+ ```Ruby
57
+ gem "just-the-docs", "0.4.0.rc4"
58
+ ```
59
+
60
+ By default, **users will not be upgraded to `0.4.0.rc4`**. To enforce that explicitly, either:
61
+
62
+ 1. pin your gem version in your `Gemfile`, like so
63
+ ```Ruby
64
+ gem "just-the-docs", "0.3.3"
65
+ ```
66
+ 2. freeze the `remote_theme`, like so
67
+ ```yml
68
+ remote_theme: just-the-docs/just-the-docs@v0.3.3
69
+ ```
70
+
71
+ ### New Features
72
+
73
+ - Added: support multiple Google Analytics tracking IDs, document UA -> GA4 switch by [@MichelleBlanchette] in [#1029]
74
+ - Added: copy code button to code snippets by [@simonebortolin] in [#945]
75
+ - Added: restore simple configuration of `favicon.ico` via `site.static_files` by [@pdmosses] in [#1095]
76
+ - Added: modularize site components by [@mattxwang] in [#1058]
77
+
78
+ ### Bugfixes and Maintenance
79
+
80
+ - Fixed: incorrect disambiguation in generated TOCs by [@pdmosses] in [#999]
81
+ - Fixed: duplicated external links in collections by [@pdmosses] in [#1001]
82
+ - Fixed: import order of `custom.scss`; puts at end by [@deseo] in [#1010]
83
+ - Fixed: top-level active link styling by [@pdmosses] in [#1015]
84
+ - Fixed: external links for sites with no pages by [@pdmosses] in [#1021]
85
+ - Fixed: duplicate `title` if `jekyll-seo-tag` not in users's plugins by [@Tom-Brouwer] in [#1040]
86
+ - Fixed: removes (duplicate) `favicon.html`, shifts content to `head_custom.html` by [@mattxwang] in [#1027]
87
+ - Fixed: add `reversed`, deprecate `desc` for nav `child_nav_order` by [@jmertic] in [#1061]
88
+ - Fixed: `child.child_nav_order` to `node.child_nav_order` by [@mattxwang] in [#1065]
89
+ - Fixed: remove all uses of `/` as SASS division by [@mattxwang] in [#1074]
90
+ - note: this was originally merged as [#1074] with a bug; it was reverted in [#1076], and then reimplemented in [#1077]
91
+ - Fixed: skip nav collection generation when site has no pages by [@pdmosses] in [#1092]
92
+ - Fixed: standardize SCSS with `declaration-block-no-redundant-longhand-properties` by [@simonebortolin] in [#1102]
93
+ - Fixed: incorrect `padding` property value pair in `labels.scss` by [@SConaway] in [#1104]
94
+ - Fixed: various bugs with copy code button by [@simonebortolin] in [#1096]
95
+ - Fixed: replace inline styling for `<svg>` icons by [@captn3m0] in [#1110]
96
+ - Vendor: update `jekyll-anchor-headings`, `lunr.js` by [@mattxwang] in [#1071]
97
+
98
+ ### Docs
99
+
100
+ - Docs: fix typo in changelog links [@koppor] in [#1000]
101
+ - Docs: update homepage (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1018]
102
+ - Docs: update README (focus: new features, conciseness, deduplication) by [@pdmosses] in [#1019]
103
+ - Docs: fix two bugs in "Customization" (custom favicon, new annotation) by [@mattxwang] in [#1090]
104
+ - Docs: Add warning about mandatory `_`-prefix for collections by [@max06] in [#1091]
105
+ - Docs: remove Google Analytics on main site by [@mattxwang] in [#1113]
106
+
107
+ ### New Contributors
108
+
109
+ - [@koppor] made their first contribution in [#1000]
110
+ - [@deseo] made their first contribution in [#1010]
111
+ - [@Tom-Brouwer] made their first contribution in [#1040]
112
+ - [@simonebortolin] made their first contribution in [#945]
113
+ - [@SConaway] made their first contribution in [#1104]
114
+ - [@captn3m0] made their first contribution in [#1110]
115
+
116
+ **Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.4.0.rc3...v0.4.0.rc4
117
+
118
+ [#945]: https://github.com/just-the-docs/just-the-docs/pull/945
119
+ [#999]: https://github.com/just-the-docs/just-the-docs/pull/999
120
+ [#1000]: https://github.com/just-the-docs/just-the-docs/pull/1000
121
+ [#1001]: https://github.com/just-the-docs/just-the-docs/pull/1001
122
+ [#1010]: https://github.com/just-the-docs/just-the-docs/pull/1010
123
+ [#1015]: https://github.com/just-the-docs/just-the-docs/pull/1015
124
+ [#1018]: https://github.com/just-the-docs/just-the-docs/pull/1018
125
+ [#1019]: https://github.com/just-the-docs/just-the-docs/pull/1019
126
+ [#1021]: https://github.com/just-the-docs/just-the-docs/pull/1021
127
+ [#1027]: https://github.com/just-the-docs/just-the-docs/pull/1027
128
+ [#1029]: https://github.com/just-the-docs/just-the-docs/pull/1029
129
+ [#1040]: https://github.com/just-the-docs/just-the-docs/pull/1040
130
+ [#1058]: https://github.com/just-the-docs/just-the-docs/pull/1058
131
+ [#1061]: https://github.com/just-the-docs/just-the-docs/pull/1061
132
+ [#1065]: https://github.com/just-the-docs/just-the-docs/pull/1065
133
+ [#1071]: https://github.com/just-the-docs/just-the-docs/pull/1071
134
+ [#1074]: https://github.com/just-the-docs/just-the-docs/pull/1074
135
+ [#1076]: https://github.com/just-the-docs/just-the-docs/pull/1076
136
+ [#1077]: https://github.com/just-the-docs/just-the-docs/pull/1077
137
+ [#1090]: https://github.com/just-the-docs/just-the-docs/pull/1090
138
+ [#1091]: https://github.com/just-the-docs/just-the-docs/pull/1091
139
+ [#1092]: https://github.com/just-the-docs/just-the-docs/pull/1092
140
+ [#1095]: https://github.com/just-the-docs/just-the-docs/pull/1095
141
+ [#1096]: https://github.com/just-the-docs/just-the-docs/pull/1096
142
+ [#1102]: https://github.com/just-the-docs/just-the-docs/pull/1102
143
+ [#1104]: https://github.com/just-the-docs/just-the-docs/pull/1104
144
+ [#1110]: https://github.com/just-the-docs/just-the-docs/pull/1110
145
+ [#1113]: https://github.com/just-the-docs/just-the-docs/pull/1113
146
+
147
+ [@captn3m0]: https://github.com/captn3m0
148
+ [@deseo]: https://github.com/deseo
149
+ [@koppor]: https://github.com/koppor
150
+ [@MichelleBlanchette]: https://github.com/MichelleBlanchette
151
+ [@simonebortolin]: https://github.com/simonebortolin
152
+ [@SConaway]: https://github.com/SConaway
153
+ [@Tom-Brouwer]: https://github.com/Tom-Brouwer
24
154
 
25
155
  ## Pre-release v0.4.0.rc3
26
156
 
@@ -433,31 +563,31 @@ as well as DX improvements like better regression tests, CI, and tooling. If you
433
563
  * [@ivanskodje] made their first contribution in [#891]
434
564
  * [@Eisverygoodletter] made their first contribution in [#893]
435
565
 
436
- [@AdityaTiwari2102]: https://githhub.com/AdityaTiwari2102
437
- [@svrooij]: https://githhub.com/svrooij
438
- [@alexsegura]: https://githhub.com/alexsegura
439
- [@burner1024]: https://githhub.com/burner1024
440
- [@JeffGuKang]: https://githhub.com/JeffGuKang
441
- [@dougaitken]: https://githhub.com/dougaitken
442
- [@max06]: https://githhub.com/max06
443
- [@sehilyi]: https://githhub.com/sehilyi
444
- [@nathanjessen]: https://githhub.com/nathanjessen
445
- [@waldyrious]: https://githhub.com/waldyrious
446
- [@MichelleBlanchette]: https://githhub.com/MichelleBlanchette
447
- [@henryiii]: https://githhub.com/henryiii
448
- [@jmertic]: https://githhub.com/jmertic
449
- [@jacobhq]: https://githhub.com/jacobhq
450
- [@UnclassedPenguin]: https://githhub.com/UnclassedPenguin
451
- [@alyssais]: https://githhub.com/alyssais
452
- [@nascosto]: https://githhub.com/nascosto
453
- [@SPGoding]: https://githhub.com/SPGoding
454
- [@iridazzle]: https://githhub.com/iridazzle
455
- [@ivanskodje]: https://githhub.com/ivanskodje
456
- [@Eisverygoodletter]: https://githhub.com/Eisverygoodletter
566
+ [@AdityaTiwari2102]: https://github.com/AdityaTiwari2102
567
+ [@svrooij]: https://github.com/svrooij
568
+ [@alexsegura]: https://github.com/alexsegura
569
+ [@burner1024]: https://github.com/burner1024
570
+ [@JeffGuKang]: https://github.com/JeffGuKang
571
+ [@dougaitken]: https://github.com/dougaitken
572
+ [@max06]: https://github.com/max06
573
+ [@sehilyi]: https://github.com/sehilyi
574
+ [@nathanjessen]: https://github.com/nathanjessen
575
+ [@waldyrious]: https://github.com/waldyrious
576
+ [@MichelleBlanchette]: https://github.com/MichelleBlanchette
577
+ [@henryiii]: https://github.com/henryiii
578
+ [@jmertic]: https://github.com/jmertic
579
+ [@jacobhq]: https://github.com/jacobhq
580
+ [@UnclassedPenguin]: https://github.com/UnclassedPenguin
581
+ [@alyssais]: https://github.com/alyssais
582
+ [@nascosto]: https://github.com/nascosto
583
+ [@SPGoding]: https://github.com/SPGoding
584
+ [@iridazzle]: https://github.com/iridazzle
585
+ [@ivanskodje]: https://github.com/ivanskodje
586
+ [@Eisverygoodletter]: https://github.com/Eisverygoodletter
457
587
 
458
588
  **Full Changelog**: https://github.com/just-the-docs/just-the-docs/compare/v0.3.3...v0.4.0.rc1
459
589
 
460
- [@pmarsceill]: https://githhub.com/pmarsceill
590
+ [@pmarsceill]: https://github.com/pmarsceill
461
591
 
462
592
  ## v0.3.3
463
593
 
data/README.md CHANGED
@@ -13,18 +13,28 @@
13
13
 
14
14
  ## Installation
15
15
 
16
- ### via GitHub Pages remote theme
16
+ ### Use the template
17
17
 
18
- The quickiest way to use Just The Docs is to use GitHub pages [remote theme](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/) feature in your `_config.yml` file:
18
+ The [Just the Docs Template] provides the simplest, quickest, and easiest way to create a new website that uses the Just the Docs theme. To get started with creating a site, just click "[use the template]"!
19
19
 
20
- ```yaml
21
- remote_theme: just-the-docs/just-the-docs
22
- ```
23
- ### via RubyGems:
20
+ Note: To use the theme, you do ***not*** need to clone or fork the [Just the Docs repo]! You should do that only if you intend to browse the theme docs locally, contribute to the development of the theme, or develop a new theme based on Just the Docs.
21
+
22
+ You can easily set the site created by the template to be published on [GitHub Pages] – the [template README] file explains how to do that, along with other details.
23
+
24
+ If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^2] And you will be able to deploy your local build to a different platform than GitHub Pages.
25
+
26
+ More specifically, the created site:
24
27
 
25
- Alternatively you can install it as a Ruby Gem.
28
+ - uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem
29
+ - uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages
26
30
 
27
- Add this line to your Jekyll site's Gemfile:
31
+ Other than that, you're free to customize sites that you create with the template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.
32
+
33
+ ### Use RubyGems
34
+
35
+ Alternatively, you can install the theme as a Ruby Gem, without creating a new site.
36
+
37
+ Add this line to your Jekyll site's `Gemfile`:
28
38
 
29
39
  ```ruby
30
40
  gem "just-the-docs"
@@ -50,16 +60,19 @@ Alternatively, you can run it inside Docker while developing your site
50
60
 
51
61
  ## Usage
52
62
 
53
- [View the documentation](https://just-the-docs.github.io/just-the-docs/) for usage information.
63
+ [View the documentation][Just the Docs] for usage information.
54
64
 
55
65
  ## Contributing
56
66
 
57
- Bug reports and pull requests are welcome on GitHub at https://github.com/just-the-docs/just-the-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
67
+ Bug reports, proposals of new features, and pull requests are welcome on GitHub at https://github.com/just-the-docs/just-the-docs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
58
68
 
59
69
  ### Submitting code changes:
60
70
 
71
+ - Submit an [Issue](https://github.com/just-the-docs/just-the-docs/issues) that motivates the changes, using the appropriate template
72
+ - Discuss the proposed changes with other users and the maintainers
61
73
  - Open a [Pull Request](https://github.com/just-the-docs/just-the-docs/pulls)
62
74
  - Ensure all CI tests pass
75
+ - Provide instructions to check the effect of the changes
63
76
  - Await code review
64
77
 
65
78
  ### Design and development principles of this theme:
@@ -71,14 +84,25 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/just-t
71
84
 
72
85
  ## Development
73
86
 
74
- To set up your environment to develop this theme, run `bundle install`.
87
+ To set up your environment to develop this theme: fork this repo, the run `bundle install` from the root directory.
75
88
 
76
89
  A modern [devcontainer configuration](https://code.visualstudio.com/docs/remote/containers) for VSCode is included.
77
90
 
78
91
  Your theme is set up just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
79
92
 
80
- When the theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
93
+ When this theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be included in the gem.
81
94
 
82
95
  ## License
83
96
 
84
97
  The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
98
+
99
+ [^2]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
100
+
101
+ [Jekyll]: https://jekyllrb.com
102
+ [Just the Docs Template]: https://just-the-docs.github.io/just-the-docs-template/
103
+ [Just the Docs]: https://just-the-docs.github.io/just-the-docs/
104
+ [Just the Docs repo]: https://github.com/just-the-docs/just-the-docs
105
+ [GitHub Pages]: https://pages.github.com/
106
+ [Template README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
107
+ [GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
108
+ [use the template]: https://github.com/just-the-docs/just-the-docs-template/generate
@@ -0,0 +1,15 @@
1
+ <nav aria-label="Auxiliary" class="aux-nav">
2
+ <ul class="aux-nav-list">
3
+ {% for link in site.aux_links %}
4
+ <li class="aux-nav-list-item">
5
+ <a href="{{ link.last }}" class="site-button"
6
+ {% if site.aux_links_new_tab %}
7
+ target="_blank" rel="noopener noreferrer"
8
+ {% endif %}
9
+ >
10
+ {{ link.first }}
11
+ </a>
12
+ </li>
13
+ {% endfor %}
14
+ </ul>
15
+ </nav>
@@ -0,0 +1,15 @@
1
+ {% unless page.url == "/" %}
2
+ {% if page.parent %}
3
+ <nav aria-label="Breadcrumb" class="breadcrumb-nav">
4
+ <ol class="breadcrumb-nav-list">
5
+ {% if page.grand_parent %}
6
+ <li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.grand_parent }}</a></li>
7
+ <li class="breadcrumb-nav-list-item"><a href="{{ second_level_url }}">{{ page.parent }}</a></li>
8
+ {% else %}
9
+ <li class="breadcrumb-nav-list-item"><a href="{{ first_level_url }}">{{ page.parent }}</a></li>
10
+ {% endif %}
11
+ <li class="breadcrumb-nav-list-item"><span>{{ page.title }}</span></li>
12
+ </ol>
13
+ </nav>
14
+ {% endif %}
15
+ {% endunless %}
@@ -0,0 +1,9 @@
1
+ <hr>
2
+ {% include toc_heading_custom.html %}
3
+ <ul>
4
+ {% for child in include.toc_list %}
5
+ <li>
6
+ <a href="{{ child.url | relative_url }}">{{ child.title }}</a>{% if child.summary %} - {{ child.summary }}{% endif %}
7
+ </li>
8
+ {% endfor %}
9
+ </ul>
@@ -0,0 +1,34 @@
1
+ {% capture footer_custom %}
2
+ {%- include footer_custom.html -%}
3
+ {% endcapture %}
4
+ {% if footer_custom != "" or site.last_edit_timestamp or site.gh_edit_link %}
5
+ <hr>
6
+ <footer>
7
+ {% if site.back_to_top %}
8
+ <p><a href="#top" id="back-to-top">{{ site.back_to_top_text }}</a></p>
9
+ {% endif %}
10
+
11
+ {{ footer_custom }}
12
+
13
+ {% if site.last_edit_timestamp or site.gh_edit_link %}
14
+ <div class="d-flex mt-2">
15
+ {% if site.last_edit_timestamp and site.last_edit_time_format and page.last_modified_date %}
16
+ <p class="text-small text-grey-dk-000 mb-0 mr-2">
17
+ Page last modified: <span class="d-inline-block">{{ page.last_modified_date | date: site.last_edit_time_format }}</span>.
18
+ </p>
19
+ {% endif %}
20
+ {% if
21
+ site.gh_edit_link and
22
+ site.gh_edit_link_text and
23
+ site.gh_edit_repository and
24
+ site.gh_edit_branch and
25
+ site.gh_edit_view_mode
26
+ %}
27
+ <p class="text-small text-grey-dk-000 mb-0">
28
+ <a href="{{ site.gh_edit_repository }}/{{ site.gh_edit_view_mode }}/{{ site.gh_edit_branch }}{% if site.gh_edit_source %}/{{ site.gh_edit_source }}{% endif %}{% if page.collection and site.collections_dir %}/{{ site.collections_dir }}{% endif %}/{{ page.path }}" id="edit-this-page">{{ site.gh_edit_link_text }}</a>
29
+ </p>
30
+ {% endif %}
31
+ </div>
32
+ {% endif %}
33
+ </footer>
34
+ {% endif %}
@@ -0,0 +1,11 @@
1
+ <div id="main-header" class="main-header">
2
+ {% if site.search_enabled != false %}
3
+ {% include components/search_header.html %}
4
+ {% else %}
5
+ <div></div>
6
+ {% endif %}
7
+ {% include header_custom.html %}
8
+ {% if site.aux_links %}
9
+ {% include components/aux_nav.html %}
10
+ {% endif %}
11
+ </div>
@@ -0,0 +1,5 @@
1
+ <script>
2
+ var config = {% include mermaid_config.js %};
3
+ mermaid.initialize(config);
4
+ window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
5
+ </script>
@@ -0,0 +1,7 @@
1
+ {% if site.search.button %}
2
+ <a href="#" id="search-button" class="search-button">
3
+ <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-search"></use></svg>
4
+ </a>
5
+ {% endif %}
6
+
7
+ <div class="search-overlay"></div>
@@ -0,0 +1,9 @@
1
+ {% capture search_placeholder %}{% include search_placeholder_custom.html %}{% endcapture %}
2
+
3
+ <div class="search">
4
+ <div class="search-input-wrap">
5
+ <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="{{ search_placeholder | strip_html | strip }}" aria-label="{{ search_placeholder | strip_html| strip }}" autocomplete="off">
6
+ <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label>
7
+ </div>
8
+ <div id="search-results" class="search-results"></div>
9
+ </div>
@@ -0,0 +1,69 @@
1
+ <div class="side-bar">
2
+ <div class="site-header">
3
+ <a href="{{ '/' | relative_url }}" class="site-title lh-tight">{% include title.html %}</a>
4
+ <a href="#" id="menu-button" class="site-button">
5
+ <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-menu"></use></svg>
6
+ </a>
7
+ </div>
8
+ <nav aria-label="Main" id="site-nav" class="site-nav">
9
+ {% assign pages_top_size = site.html_pages
10
+ | where_exp:"item", "item.title != nil"
11
+ | where_exp:"item", "item.parent == nil"
12
+ | where_exp:"item", "item.nav_exclude != true"
13
+ | size %}
14
+ {% if pages_top_size > 0 %}
15
+ {% include nav.html pages=site.html_pages key=nil %}
16
+ {% endif %}
17
+ {%- if site.nav_external_links -%}
18
+ <ul class="nav-list">
19
+ {%- for node in site.nav_external_links -%}
20
+ <li class="nav-list-item external">
21
+ <a href="{{ node.url | absolute_url }}" class="nav-list-link external">
22
+ {{ node.title }}
23
+ {% unless node.hide_icon %}<svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg>{% endunless %}
24
+ </a>
25
+ </li>
26
+ {%- endfor -%}
27
+ </ul>
28
+ {%- endif -%}
29
+ {% if site.just_the_docs.collections %}
30
+ {% assign collections_size = site.just_the_docs.collections | size %}
31
+ {% for collection_entry in site.just_the_docs.collections %}
32
+ {% assign collection_key = collection_entry[0] %}
33
+ {% assign collection_value = collection_entry[1] %}
34
+ {% assign collection = site[collection_key] %}
35
+ {% if collection_value.nav_exclude != true %}
36
+ {% if collections_size > 1 or pages_top_size > 0 %}
37
+ {% if collection_value.nav_fold == true %}
38
+ <ul class="nav-list nav-category-list">
39
+ <li class="nav-list-item{% if page.collection == collection_key %} active{% endif %}">
40
+ {%- if collection.size > 0 -%}
41
+ <a href="#" class="nav-list-expander"><svg viewBox="0 0 24 24"><use xlink:href="#svg-arrow-right"></use></svg></a>
42
+ {%- endif -%}
43
+ <div class="nav-category">{{ collection_value.name }}</div>
44
+ {% include nav.html pages=collection key=collection_key %}
45
+ </li>
46
+ </ul>
47
+ {% else %}
48
+ <div class="nav-category">{{ collection_value.name }}</div>
49
+ {% include nav.html pages=collection key=collection_key %}
50
+ {% endif %}
51
+ {% else %}
52
+ {% include nav.html pages=collection key=collection_key %}
53
+ {% endif %}
54
+ {% endif %}
55
+ {% endfor %}
56
+ {% endif %}
57
+ </nav>
58
+
59
+ {% capture nav_footer_custom %}
60
+ {%- include nav_footer_custom.html -%}
61
+ {% endcapture %}
62
+ {% if nav_footer_custom != "" %}
63
+ {{ nav_footer_custom }}
64
+ {% else %}
65
+ <footer class="site-footer">
66
+ This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
67
+ </footer>
68
+ {% endif %}
69
+ </div>
@@ -5,5 +5,5 @@ $logo: "{{ site.logo | relative_url }}";
5
5
  @import "./color_schemes/light";
6
6
  @import "./color_schemes/{{ include.color_scheme }}";
7
7
  @import "./modules";
8
- {% include css/custom.scss.liquid %}
9
8
  {% include css/callouts.scss.liquid color_scheme = include.color_scheme %}
9
+ {% include css/custom.scss.liquid %}
data/_includes/head.html CHANGED
@@ -2,28 +2,20 @@
2
2
  <meta charset="UTF-8">
3
3
  <meta http-equiv="X-UA-Compatible" content="IE=Edge">
4
4
 
5
- {% unless site.plugins contains "jekyll-seo-tag" %}
6
- <title>{{ page.title }} - {{ site.title }}</title>
7
-
8
- {% if page.description %}
9
- <meta name="Description" content="{{ page.description }}">
10
- {% endif %}
11
- {% endunless %}
12
-
13
- {% include favicon.html %}
14
-
15
5
  <link rel="stylesheet" href="{{ '/assets/css/just-the-docs-default.css' | relative_url }}">
16
6
 
17
7
  {% if site.ga_tracking != nil %}
18
- <script async src="https://www.googletagmanager.com/gtag/js?id={{ site.ga_tracking }}"></script>
8
+ {% assign ga_tracking_ids = site.ga_tracking | split: "," %}
9
+ <script async src="https://www.googletagmanager.com/gtag/js?id={{ ga_tracking_ids.first }}"></script>
19
10
  <script>
20
11
  window.dataLayer = window.dataLayer || [];
21
12
  function gtag(){dataLayer.push(arguments);}
22
13
  gtag('js', new Date());
23
14
 
24
- gtag('config', '{{ site.ga_tracking }}'{% unless site.ga_tracking_anonymize_ip == nil %}, { 'anonymize_ip': true }{% endunless %});
15
+ {% for ga_property in ga_tracking_ids %}
16
+ gtag('config', '{{ ga_property }}'{% unless site.ga_tracking_anonymize_ip == nil %}, { 'anonymize_ip': true }{% endunless %});
17
+ {% endfor %}
25
18
  </script>
26
-
27
19
  {% endif %}
28
20
 
29
21
  {% if site.search_enabled != false %}
@@ -37,6 +29,15 @@
37
29
  <script src="{{ '/assets/js/just-the-docs.js' | relative_url }}"></script>
38
30
 
39
31
  <meta name="viewport" content="width=device-width, initial-scale=1">
32
+
33
+ {% for file in site.static_files %}
34
+ {% if file.path == site.favicon_ico or file.path == '/favicon.ico' %}
35
+ {% assign favicon = true %}
36
+ {% endif %}
37
+ {% endfor %}
38
+ {% if favicon %}
39
+ <link rel="icon" href="{{ site.favicon_ico | default: '/favicon.ico' | relative_url }}" type="image/x-icon">
40
+ {% endif %}
40
41
 
41
42
  {% seo %}
42
43
 
@@ -0,0 +1,15 @@
1
+ <!-- Feather. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md -->
2
+ <symbol id="svg-copy" viewBox="0 0 16 16">
3
+ <title>Copy</title>
4
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16">
5
+ <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/>
6
+ <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/>
7
+ </svg>
8
+ </symbol>
9
+ <symbol id="svg-copied" viewBox="0 0 16 16">
10
+ <title>Copied</title>
11
+ <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16">
12
+ <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/>
13
+ <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/>
14
+ </svg>
15
+ </symbol>
@@ -0,0 +1,6 @@
1
+ <symbol id="svg-doc" viewBox="0 0 24 24">
2
+ <title>Document</title>
3
+ <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file">
4
+ <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline>
5
+ </svg>
6
+ </symbol>
@@ -0,0 +1,6 @@
1
+ <symbol id="svg-arrow-right" viewBox="0 0 24 24">
2
+ <title>Expand</title>
3
+ <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right">
4
+ <polyline points="9 18 15 12 9 6"></polyline>
5
+ </svg>
6
+ </symbol>
@@ -0,0 +1,13 @@
1
+ <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
2
+ {% include icons/link.html %}
3
+ {% include icons/menu.html %}
4
+ {% include icons/expand.html %}
5
+ {% include icons/external_link.html %}
6
+ {% if site.search_enabled != false %}
7
+ {% include icons/document.html %}
8
+ {% include icons/search.html %}
9
+ {% endif %}
10
+ {% if site.enable_copy_code_button != false %}
11
+ {% include icons/code_copy.html %}
12
+ {% endif %}
13
+ </svg>
@@ -0,0 +1,6 @@
1
+ <symbol id="svg-link" viewBox="0 0 24 24">
2
+ <title>Link</title>
3
+ <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link">
4
+ <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
5
+ </svg>
6
+ </symbol>
@@ -0,0 +1,6 @@
1
+ <symbol id="svg-menu" viewBox="0 0 24 24">
2
+ <title>Menu</title>
3
+ <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu">
4
+ <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line>
5
+ </svg>
6
+ </symbol>
@@ -0,0 +1,6 @@
1
+ <symbol id="svg-search" viewBox="0 0 24 24">
2
+ <title>Search</title>
3
+ <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search">
4
+ <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line>
5
+ </svg>
6
+ </symbol>