mkdocs/mkdocs.yml at a6fc4f9420d81982a34fb87a1b6e9a37de5145c6 - mkdocs - Gitea: Git with a cup of tea

centersl/mkdocs

mirror of https://github.com/mkdocs/mkdocs.git synced 2026-03-27 09:58:31 +07:00

Files

Waylan Limberg a6fc4f9420 Refactor Markdown Extension Options Config.

Config validation now handles all extension processing:

* Builtin extensions are defined and within the default scheme.
* User extensions are defined only as a list in the config. Note, this is
  a backward incompatable change from the previous (short-lived) release.
* The users extensions are added to the list of builtins.
* Any duplicates are accounted for in validation.
* Extension options are supported by a child key/value pair on the ext name.
* All extension options are compiled into a format Markdown accepts
  within the validation process and are saved to the internal `mdx_configs`
  config setting.
* The `mdx_configs` setting is private and raises an error if set by the user.
* A whole suite of tests were added to test all aspects of ext validation.

All relevant build tests were updated to pass the config to
`build.convert_markdown` as the config now handles all extension data.

The relevant documentation was updated to reflect the changes. While I was
at it, I spellchecked the entire document and made a few additional formatting
changes.

This fixes #519 plus a lot more.

2015-05-16 10:40:55 -04:00

14 lines

372 B

YAML

Raw Blame History

 site_name: MkDocs
 site_url: http://www.mkdocs.org
 site_description: Project documentation with Markdown.
 repo_url: https://github.com/mkdocs/mkdocs/
 markdown_extensions:
     - toc:
         permalink: ""
     - admonition:
 copyright: Copyright &copy; 2014, <a href="https://twitter.com/_tomchristie">Tom Christie</a>.
 google_analytics: ['UA-27795084-5', 'mkdocs.org']