diff options
| author | Waylan Limberg <waylan.limberg@icloud.com> | 2017-12-06 23:18:29 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-12-06 23:18:29 -0500 |
| commit | b62ddeda02fadcd09def9354eb2ef46a7562a106 (patch) | |
| tree | 37149361ca1eeb8c24942835b2f933105fa920ed /mkdocs.yml | |
| parent | de5c696f94e8dde242c29d4be50b7bbf3c17fedb (diff) | |
| download | markdown-b62ddeda02fadcd09def9354eb2ef46a7562a106.tar.gz markdown-b62ddeda02fadcd09def9354eb2ef46a7562a106.tar.bz2 markdown-b62ddeda02fadcd09def9354eb2ef46a7562a106.zip | |
Switch docs to MKDocs (#602)
Fixes #601. Merged in 6f87b32 from the md3 branch and did a lot of cleanup.
Changes include:
* Removed old docs build tool, templates, etc.
* Added MkDocs config file, etc.
* filename.txt => filename.md
* pythonhost.org/Markdown => Python-Markdown.github.io
* Markdown lint and other cleanup.
* Automate pages deployment in makefile with `mkdocs gh-deploy`
Assumes a git remote is set up named "pages". Do
git remote add pages https://github.com/Python-Markdown/Python-Markdown.github.io.git
... before running `make deploy` the first time.
Diffstat (limited to 'mkdocs.yml')
| -rw-r--r-- | mkdocs.yml | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..dfecb3c --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,57 @@ +site_name: Python-Markdown +site_url: https://Python-Markdown.github.io/ +repo_url: https://github.com/Python-Markdown/markdown +site_author: "The Python-Markdown Project" +copyright: "Copyright © 2010-2017" + +use_directory_urls: true + +theme: + name: nature + icon: py.png + release: 2.6.9 + issue_tracker: https://github.com/Python-Markdown/markdown/issues + +pages: + - Python-Markdown: index.md + - Installation: install.md + - Library Reference: reference.md + - Command Line: cli.md + - Extensions: extensions/index.md + - Officially Supported Extensions: + - Abbreviations: extensions/abbreviations.md + - Admonition: extensions/admonition.md + - Attribute Lists: extensions/attr_list.md + - CodeHilite: extensions/code_hilite.md + - Definition Lists: extensions/definition_lists.md + - Extra: extensions/extra.md + - Fenced Code Blocks: extensions/fenced_code_blocks.md + - Footnotes: extensions/footnotes.md + - HeaderId: extensions/header_id.md + - Meta-Data: extensions/meta_data.md + - New Line to Break: extensions/nl2br.md + - Sane Lists: extensions/sane_lists.md + - Smart Strong: extensions/smart_strong.md + - SmartyPants: extensions/smarty.md + - Table of Contents: extensions/toc.md + - Tables: extensions/tables.md + - WikiLinks: extensions/wikilinks.md + - Extension API: extensions/api.md + - Test Suite: test_suite.md + - Change Log: change_log/index.md + - Release Notes for v.2.6: change_log/release-2.6.md + - Release Notes for v.2.5: change_log/release-2.5.md + - Release Notes for v.2.4: change_log/release-2.4.md + - Release Notes for v.2.3: change_log/release-2.3.md + - Release Notes for v.2.2: change_log/release-2.2.md + - Release Notes for v.2.1: change_log/release-2.1.md + - Release Notes for v.2.0: change_log/release-2.0.md + - Authors: authors.md + +markdown_extensions: + - extra + - admonition + - smarty + - codehilite + - toc: + permalink: true |