Skip to content

Commit e204cf4

Browse files
committed
fixup some docs
1 parent 9244cce commit e204cf4

File tree

5 files changed

+10
-8
lines changed

5 files changed

+10
-8
lines changed

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pip3 install mkdocs-git-authors-plugin
1212

1313
Next, add the following lines to your `mkdocs.yml`:
1414

15-
```yml
15+
```yaml
1616
plugins:
1717
- search
1818
- git-authors

docs/options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
You can customize the plugin by setting options in your `mkdocs.yml` file. Here is an example of all the options this plugin offers:
44

5-
```yml
5+
```yaml
66
plugins:
77
- git-authors:
88
show_contribution: true

docs/overrides/main.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
{% if git_page_authors %}
77
<div class="md-source-date">
88
<small>
9-
Authors: {{ git_page_authors }}
9+
Authors: {{ git_page_authors | default('enable mkdocs-git-authors-plugin') }}
1010
</small>
1111
</div>
1212
{% endif %}

docs/usage.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ If you use the [mkdocs-material](https://github.com/squidfunk/mkdocs-material) t
4141
{% if git_page_authors %}
4242
<div class="md-source-date">
4343
<small>
44-
Authors: {{ git_page_authors }}
44+
Authors: {{ git_page_authors | default('enable mkdocs-git-authors-plugin') }}
4545
</small>
4646
</div>
4747
{% endif %}
@@ -50,7 +50,7 @@ If you use the [mkdocs-material](https://github.com/squidfunk/mkdocs-material) t
5050

5151
2) In `mkdocs.yml` make sure to specify the custom directory with the theme overrides:
5252

53-
```yml
53+
```yaml
5454
theme:
5555
name: material
5656
custom_dir: docs/overrides
@@ -77,13 +77,13 @@ https://github.com/mkdocs/mkdocs/blob/master/mkdocs/themes/mkdocs/content.html -
7777
{{ page.content }}
7878
7979
{% if git_page_authors %}
80-
<p><small>Authors: {{ git_page_authors }}</small></p>
80+
<p><small>Authors: {{ git_page_authors | default('enable mkdocs-git-authors-plugin') }}</small></p>
8181
{% endif %}
8282
```
8383

8484
2) In `mkdocs.yml` make sure to specify the custom directory with the theme overrides:
8585

86-
```yml
86+
```yaml
8787
theme:
8888
name: mkdocs
8989
custom_dir: docs/overrides

mkdocs.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,6 @@ nav:
2323
- Contributing: contributing.md
2424

2525
markdown_extensions:
26-
- markdown.extensions.codehilite
26+
- markdown.extensions.codehilite
27+
- pymdownx.escapeall
28+
- pymdownx.superfences

0 commit comments

Comments
 (0)