From b62ddeda02fadcd09def9354eb2ef46a7562a106 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Wed, 6 Dec 2017 23:18:29 -0500 Subject: 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. --- docs/extensions/admonition.txt | 75 ------------------------------------------ 1 file changed, 75 deletions(-) delete mode 100644 docs/extensions/admonition.txt (limited to 'docs/extensions/admonition.txt') diff --git a/docs/extensions/admonition.txt b/docs/extensions/admonition.txt deleted file mode 100644 index d68bd5d..0000000 --- a/docs/extensions/admonition.txt +++ /dev/null @@ -1,75 +0,0 @@ -title: Admonition Extension -prev_title: Smart Strong Extension -prev_url: smart_strong.html -next_title: CodeHilite Extension -next_url: code_hilite.html - -Admonition -========== - -Summary -------- - -The Admonition extension adds [rST-style][rST] admonitions to Markdown documents. - -This extension is included in the standard Markdown library. - -[rST]: http://docutils.sourceforge.net/docs/ref/rst/directives.html#specific-admonitions - -Syntax ------- - -Admonitions are created using the following syntax: - - !!! type "optional explicit title within double quotes" - Any number of other indented markdown elements. - - This is the second paragraph. - -`type` will be used as the CSS class name and as default title. It must be a -single word. So, for instance: - - !!! note - You should note that the title will be automatically capitalized. - -will render: - -
-

Note

-

You should note that the title will be automatically capitalized.

-
- -Optionally, you can use custom titles. For instance: - - !!! danger "Don't try this at home" - ... - -will render: - -
-

Don't try this at home

-

...

-
- -If you don't want a title, use a blank string `""`: - - !!! important "" - This is a admonition box without a title. - -results in: - -
-

This is a admonition box without a title.

-
- - -rST suggests the following `types`, but you're free to use whatever you want: - attention, caution, danger, error, hint, important, note, tip, warning. - -Styling -------- - -There is no CSS included as part of this extension. Look up the default -[Sphinx][sphinx] theme if you need inspiration. - -[sphinx]: http://sphinx.pocoo.org/ -- cgit v1.2.3