File tree Expand file tree Collapse file tree 5 files changed +10
-8
lines changed
Expand file tree Collapse file tree 5 files changed +10
-8
lines changed Original file line number Diff line number Diff line change @@ -12,7 +12,7 @@ pip3 install mkdocs-git-authors-plugin
1212
1313Next, add the following lines to your ` mkdocs.yml ` :
1414
15- ``` yml
15+ ``` yaml
1616plugins :
1717 - search
1818 - git-authors
Original file line number Diff line number Diff line change 22
33You 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
66plugins :
77 - git-authors :
88 show_contribution : true
Original file line number Diff line number Diff line change 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 %}
Original file line number Diff line number Diff 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
51512 ) In ` mkdocs.yml ` make sure to specify the custom directory with the theme overrides:
5252
53- ``` yml
53+ ``` yaml
5454theme :
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
84842) In `mkdocs.yml` make sure to specify the custom directory with the theme overrides :
8585
86- ` ` ` yml
86+ ` ` ` yaml
8787theme:
8888 name: mkdocs
8989 custom_dir: docs/overrides
Original file line number Diff line number Diff line change 2323 - Contributing : contributing.md
2424
2525markdown_extensions :
26- - markdown.extensions.codehilite
26+ - markdown.extensions.codehilite
27+ - pymdownx.escapeall
28+ - pymdownx.superfences
You can’t perform that action at this time.
0 commit comments