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:
Glen Whitney 2021-01-07 22:39:40 -08:00
parent 6004ed0c0f
commit ec9c7e57ce
6 changed files with 76 additions and 2 deletions

18
mkdocs.yml Normal file
View file

@ -0,0 +1,18 @@
site_name: MkDocs semiliterate plugin
nav:
- Overview: README.md
- Usage: mkdocs_semiliterate/plugin.md
plugins:
- search
- semiliterate:
merge_docs_dir: false
ignore_folders: [dist]
include_extensions: [LICENSE]
# semiliterate:
# - pattern: '(\.md)$'
# replace: [['^(.*)<!-- repo: -->.*<!-- site:(.*?) -->(.*\s*)$', '\1\2\3']]
markdown_extensions:
- abbr
theme:
name: readthedocs
docs_dir: mkdocs_semiliterate # dummy