Skip to content

Commit ecba650

Browse files
committed
Update output sample of mkdocs material.
1 parent 65facc7 commit ecba650

File tree

281 files changed

+508
-191
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

281 files changed

+508
-191
lines changed

samples/mkdocs-material/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
| | |
88
| ---------: | --------------------------------------------- |
99
| Repository | https://github.com/squidfunk/mkdocs-material/ |
10-
| Commit | 175498da779810933e68527ae801598cd2492292 |
10+
| Commit | 81944ae1a1c3de0b37691c6dc3a0bc70fe4980b9 |
1111

1212
- use Original
1313
- .browserslistrc
@@ -27,16 +27,17 @@ INFO - Building documentation to directory: /tmp/mkdocs-with-pdf/samples/mkd
2727
WARNING - Missing article: [Home]()
2828
INFO - Number headings up to level 3.
2929
INFO - Generate a table of contents up to heading level 2.
30-
INFO - Generate a cover page.
30+
INFO - Generate a cover page with "default_cover.html.j2".
31+
INFO - Generate a back cover page with "default_back_cover.html.j2".
3132
INFO - Converting <img> alignment(workaround).
3233
INFO - Converting <iframe> to poster image(if available).
3334
INFO - Converting for two-column layout(heading level 3).
3435
INFO - Rendering on `Headless Chrome`(execute JS).
3536
INFO - Rendering for PDF.
3637
INFO - Output a PDF to "/tmp/mkdocs-with-pdf/samples/mkdocs-material/site/../document.pdf".
3738
ERROR - No anchor #.: for internal URI reference
38-
INFO - Converting 37 articles to PDF took 268.5s
39-
INFO - Documentation built in 271.76 seconds
39+
INFO - Converting 38 articles to PDF took 272.3s
40+
INFO - Documentation built in 275.89 seconds
4041
```
4142

4243
## TODO
Loading

samples/mkdocs-material/docs/changelog.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,11 @@ template: overrides/main.html
66

77
## Material for MkDocs Insiders
88

9+
### 1.8.0 <small>_ November 1, 2020</small>
10+
11+
* Added support for navigation sections
12+
* Fixed appearance of inactive search suggestions
13+
914
### 1.7.0 <small>_ October 25, 2020</small>
1015

1116
* Added support for deploying multiple versions
@@ -53,6 +58,14 @@ template: overrides/main.html
5358

5459
## Material for MkDocs
5560

61+
### 6.1.2 <small>_ October 31, 2020</small>
62+
63+
* Fixed sizing of icons in Admonition, Tasklist, etc. (6.1.1 regression)
64+
65+
### 6.1.1 <small>_ October 31, 2020</small>
66+
67+
* Fixed #2019: Page title not correctly updated when using instant loading
68+
5669
### 6.1.0 <small>_ October 17, 2020</small>
5770

5871
* Fixed #1973: Added support for printing in dark mode

samples/mkdocs-material/docs/insiders.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -65,26 +65,28 @@ for MkDocs Insiders. You can click on each feature to learn more about it:
6565
- [x] [Search suggestions help to save keystrokes][14]
6666
- [x] [Highlighting of matched search terms in content area][15]
6767
- [x] Search goes to first result on ++enter++ (I'm feeling lucky)
68-
- [x] [Navigation can always be expanded via configuration][16]
69-
- [x] [Header can be automatically hidden on scrolling][17]
70-
- [x] [Table of contents can be automatically hidden when empty][18]
68+
- [x] [Navigation can be grouped into sections][16]
69+
- [x] [Navigation can always be expanded via configuration][17]
70+
- [x] [Header can be automatically hidden on scrolling][18]
71+
- [x] [Table of contents can be automatically hidden when empty][19]
7172

7273
[11]: setup/setting-up-the-footer.md#remove-generator
7374
[12]: setup/changing-the-colors.md#color-palette-toggle
7475
[13]: setup/setting-up-versioning.md#versioning
7576
[14]: setup/setting-up-site-search.md#search-suggestions
7677
[15]: setup/setting-up-site-search.md#search-highlighting
77-
[16]: setup/setting-up-navigation.md#navigation-expansion
78-
[17]: setup/setting-up-the-header.md#automatic-hiding
79-
[18]: setup/setting-up-navigation.md#automatic-hiding
78+
[16]: setup/setting-up-navigation.md#navigation-sections
79+
[17]: setup/setting-up-navigation.md#navigation-expansion
80+
[18]: setup/setting-up-the-header.md#automatic-hiding
81+
[19]: setup/setting-up-navigation.md#automatic-hiding
8082

8183
## Roadmap
8284

8385
The following list of funding goals – named after varieties of chili peppers
84-
[I'm growing on my balcony][19] – shows which features are already available
86+
[I'm growing on my balcony][20] – shows which features are already available
8587
in Material for MkDocs Insiders.
8688

87-
[19]: https://www.instagram.com/squidfunk/
89+
[20]: https://www.instagram.com/squidfunk/
8890

8991
### Madame Jeanette
9092

@@ -100,9 +102,10 @@ in Material for MkDocs Insiders.
100102
[:octicons-flame-24: Funding goal: __$1,000__][6] ·
101103
:octicons-lock-24: Status: _exclusive_
102104

103-
- [x] [Navigation can always be expanded via configuration][16]
104-
- [x] [Header can be automatically hidden on scrolling][17]
105-
- [x] [Table of contents can be automatically hidden when empty][18]
105+
- [x] [Navigation can be grouped into sections][16]
106+
- [x] [Navigation can always be expanded via configuration][17]
107+
- [x] [Header can be automatically hidden on scrolling][18]
108+
- [x] [Table of contents can be automatically hidden when empty][19]
106109
- [ ] Table of contents can be moved into navigation for more space
107110
- [ ] Better support for wide screens, i.e. more horizontal space
108111

@@ -156,10 +159,10 @@ improvements (e.g. search) do not require any changes to existing configuration.
156159
This means that your users will be able to build the docs locally with the
157160
regular version and when they push their changes to CI/CD, they will be built
158161
with Material for MkDocs Insiders. For this reason, it's recommended to
159-
[install Insiders][20] only in CI, as you don't want to expose your `GH_TOKEN`
162+
[install Insiders][21] only in CI, as you don't want to expose your `GH_TOKEN`
160163
to users.
161164

162-
[20]: publishing-your-site.md#github-pages
165+
[21]: publishing-your-site.md#github-pages
163166

164167
### Terms
165168

@@ -169,7 +172,7 @@ terms?_
169172

170173
Yes. Whether you're an individual or a company, you may use _Material for MkDocs
171174
Insiders_ precisely under the same terms as Material for MkDocs, which are given
172-
by the [MIT license][21]. However, we kindly ask you to respect the following
175+
by the [MIT license][22]. However, we kindly ask you to respect the following
173176
guidelines:
174177

175178
- Please __don't distribute the source code__ from Material for MkDocs Insiders.
@@ -180,7 +183,7 @@ guidelines:
180183
- If you cancel your subscription, you're removed as a collaborator and will
181184
miss out on future updates of Material for MkDocs Insiders. However, you may
182185
__use the latest version__ that's available to you __as long as you like__.
183-
Just remember that __[GitHub deletes private forks][22]__.
186+
Just remember that __[GitHub deletes private forks][23]__.
184187

185-
[21]: license.md
186-
[22]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository
188+
[22]: license.md
189+
[23]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository

samples/mkdocs-material/docs/reference/variables.md

Lines changed: 60 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,12 +88,70 @@ _Result_:
8888

8989
The unit price is 12.50.
9090

91+
### Using variables in snippets
92+
93+
You may want to use variables in snippets, for example, when describing the same
94+
procedure in multiple contexts where only one piece of information differs. This
95+
does not work with snippets that are included using the [Snippets][2] extension.
96+
Instead, you can use the [macros][3] plugin for defining snippets.
97+
98+
To this end, add the snippet location using the `include_dir` parameter to the
99+
plugin's configuration in `mkdocs.yml`, for example:
100+
101+
``` yaml
102+
plugins:
103+
- search
104+
- macros:
105+
include_dir: snippets
106+
```
107+
108+
In your Markdown file, you can include snippets with Jinja's [`include`][4]
109+
function:
110+
111+
``` markdown
112+
{% include "definitions.md" %}
113+
```
114+
115+
This example illustrates the behavior:
116+
117+
=== "snippets/definitions.md"
118+
119+
``` markdown
120+
The unit price is {{ page.meta.unit.price }}
121+
```
122+
123+
=== "docs/page-1.md"
124+
125+
``` markdown
126+
---
127+
unit:
128+
price: 12.50
129+
---
130+
131+
{% include "definitions.md" %}
132+
```
133+
134+
=== "docs/page-2.md"
135+
136+
``` markdown
137+
---
138+
unit:
139+
price: 25.00
140+
---
141+
142+
{% include "definitions.md" %}
143+
```
144+
145+
[2]: https://facelessuser.github.io/pymdown-extensions/extensions/snippets/
146+
[3]: #macros
147+
[4]: https://jinja.palletsprojects.com/en/2.11.x/templates/#include
148+
91149
## Customization
92150

93151
### Custom macros
94152

95153
The [macros][1] plugin allows to define custom macros, which can then be used
96-
from Markdown files. See the [official documentation][2] for more information
154+
from Markdown files. See the [official documentation][5] for more information
97155
how to define custom macros.
98156

99-
[2]: https://mkdocs-macros-plugin.readthedocs.io/en/latest/python/
157+
[5]: https://mkdocs-macros-plugin.readthedocs.io/en/latest/python/

0 commit comments

Comments
 (0)