Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Read the Docs theme #7

Merged
merged 17 commits into from
Aug 23, 2021
Merged
Prev Previous commit
Next Next commit
Add extensions #3
* Add Admonitions
* Allow custom attributes
  • Loading branch information
Ben committed Aug 16, 2021
commit a549d142ddef1e1da57975e61357068f6bc1911c
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.DS_Store
site/
.unotes
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,8 @@ pip install mkdocs-rtd-dropdown # install the rtd-dropdown theme
mkdocs serve # start the local server
```
Follow https://www.mkdocs.org/user-guide/writing-your-docs/ to write documentation

### Extensions
* [Fenced code blocks](https://python-markdown.github.io/extensions/fenced_code_blocks/)
* [Admonitions](https://python-markdown.github.io/extensions/admonition/)
* [Attribute Lists](https://python-markdown.github.io/extensions/attr_list/)
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,8 @@ extra_css:
extra_javascript:
- javascript/overrides.js
theme:
name: 'rtd-dropdown'
name: 'rtd-dropdown'
markdown_extensions:
- admonition
- attr_list
- fenced_code