Glen Whitney
b9d9b7ac0d
Update installation instructions to reflect ability to use `pip`. Add concrete examples of extraction. Resolves #9. Co-authored-by: Glen Whitney <glen@studioinfinity.org> Reviewed-on: #10 Co-Authored-By: Glen Whitney <glen@nobody@nowhere.net> Co-Committed-By: Glen Whitney <glen@nobody@nowhere.net>
31 lines
813 B
YAML
31 lines
813 B
YAML
site_name: MkDocs semiliterate plugin
|
|
nav:
|
|
- Overview: README.md
|
|
- Usage: mkdocs_semiliterate/plugin.md
|
|
- Developing: drone_develop.md
|
|
plugins:
|
|
- search
|
|
- semiliterate:
|
|
merge_docs_dir: false
|
|
ignore_folders: [build, dist, tests, semiliterate]
|
|
include_extensions: [LICENSE]
|
|
extract_standard_markdown:
|
|
extract:
|
|
replace: [['^(.*)<!-- repo: -->.*<!-- site:(.*?) -->(.*\s*)$', '\1\2\3']]
|
|
semiliterate:
|
|
- pattern: '\.py$'
|
|
extract: {start: '"""\smd', stop: '"""'}
|
|
- pattern: '.drone.yml'
|
|
destination: 'drone_develop.md'
|
|
extract:
|
|
start: '### develop'
|
|
stop: '^\s*###'
|
|
replace: ['^# (.*\s*)$', '^\s*-(.*\s*)$']
|
|
markdown_extensions:
|
|
- abbr
|
|
- def_list
|
|
- smarty
|
|
theme:
|
|
name: readthedocs
|
|
docs_dir: mkdocs_semiliterate # dummy
|