aboutsummaryrefslogtreecommitdiffstats
path: root/docs/cli.txt
Commit message (Collapse)AuthorAgeFilesLines
* Switch docs to MKDocs (#602)Waylan Limberg2017-12-061-153/+0
| | | | | | | | | | | | | | | | | | | | | | | | 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.
* Thorough spell check of the docs.Waylan Limberg2015-02-071-19/+19
|
* Some docs cleanup.Waylan Limberg2014-08-291-7/+0
|
* Mark special treatment of extension names as PendingDeprecationWaylan Limberg2014-08-291-8/+5
| | | | | | | | | | | | | | | | | The builtin extensions will no longer get special treatment and have the path ("markdown.extensions.") appended . The same applies for "mdx_" extensions. All names extension must provide the full path. Fixes #336. Also deprecating support for passing in extension config settings as part of the string name. The extension_configs keyword should be used instead. Fixes #335. Also raising PendingDeprecationWarnings for positional args or the "config" keyword on the Extension Class. Pass each setting as a seperate keyword instead. Docs and tests are updated. Still need to update extension API docs.
* Docs now use dot notation for all extensions.Waylan Limberg2014-08-291-14/+7
| | | | | | Except were "short names" are explained in the docs, all references to the buitlin extensions now use `markdown.extensions.*` in anticipation of #336.
* Added `--extension_configs` option to the CLI.Waylan Limberg2014-08-221-6/+52
| | | | | | | | | | The `--extension_configs` option must point to a YAML or JSON file. The contents of the file must parse to a Python Dict which will be passed to the `extension_configs` keyword of the `markdown.Markdown` class. Also added tests for all of the CLI option parsing options and updated documentation.
* Tweaked the docs some more.Waylan Limberg2013-02-271-11/+26
|
* Various changes to docs for updated changes, clarity, and to fix typos.Waylan Limberg2013-02-191-11/+12
|
* Rename docs/*.md => docs/*.txtWaylan Limberg2012-03-071-0/+108
The documentation uses features of Python-Markdown that are not supported on GitHub and it's better to get a source view of the docs anyway. For example, that way comments and bug reports can reference a specific line of a file. Of course, it makes sense for Github to render the README, so that is left with the `.md` file extension.