mkdocs-semiliterate/mkdocs_semiliterate/plugin.py

20 lines
580 B
Python
Raw Normal View History

""" md
## Usage
Once this plugin is [installed](../README.md#installation), in your `mkdocs.yml`
file just replace the plugin name `simple` with `semiliterate`. It accepts all
of the same parameters as `simple`, so `mkdocs` will still work as before, and
you will have immediate access to all of the following extensions:
### Inclusion syntax
To be documented when implemented.
"""
import mkdocs
from mkdocs.config import config_options
from mkdocs_simple_plugin.plugin import SimplePlugin
class SemiliteratePlugin(SimplePlugin):
""" So far, just an alias for simple """