chore: initialize setuptools project
Also provides semiliterate plugin stub, lays out basic initial documentation for the project, and adds a simple mkdocs.yml file that builds a rudimentary documentation site.
This commit is contained in:
parent
6004ed0c0f
commit
ec9c7e57ce
6 changed files with 76 additions and 2 deletions
19
mkdocs_semiliterate/plugin.py
Normal file
19
mkdocs_semiliterate/plugin.py
Normal file
|
@ -0,0 +1,19 @@
|
|||
""" 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 """
|
Loading…
Add table
Add a link
Reference in a new issue