mkdocs-semiliterate/mkdocs.yml

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: [build, dist, tests, semiliterate, .venv]
    include: [LICENSE, '.png']
    copy: true
    extract_standard_markdown:
      extract:
        replace: [['^(.*)<!-- repo: -->.*<!-- site:(.*?) -->(.*\s*)$', '\1\2\3']]
      ensurelines: false
    semiliterate:
      - pattern: '\.py$'
        extract:
          - start: '"""\smd'
            stop: '"""'
          - start: '#\sstart-md'
            stop: '#\send-md'
            replace: ['^# (.*\s*)$']
      - 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
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. 2021-01-08 06:39:40 +00:00			`site_name: MkDocs semiliterate plugin`
			`nav:`
			`- Overview: README.md`
			`- Usage: mkdocs_semiliterate/plugin.md`
test: add Drone tests Also includes installation and development documentation, and updates to the latest development version of mkdocs-simple-plugin. Resolves #3. 2021-01-09 16:11:30 +00:00			`- Developing: drone_develop.md`
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. 2021-01-08 06:39:40 +00:00			`plugins:`
			`- search`
			`- semiliterate:`
			`merge_docs_dir: false`
chore: Update to latest mkdocs-simple 3.2.0 (#25) Reviewed-on: https://code.studioinfinity.org/glen/mkdocs-semiliterate/pulls/25 Co-authored-by: Glen Whitney <glen@studioinfinity.org> Co-committed-by: Glen Whitney <glen@studioinfinity.org> 2024-09-16 02:34:34 +00:00			`ignore: [build, dist, tests, semiliterate, .venv]`
			`include: [LICENSE, '.png']`
			`copy: true`
feat: Add `extract_standard_markdown` and `report_docs_build` parameters Also includes the bootstrap manifest, which was inadvertently '.gitignore'd. Resolves #5. 2021-01-09 18:17:34 +00:00			`extract_standard_markdown:`
refactor: Adjust again to latest 'simple' commit Now with even less code! 2021-01-15 17:44:25 +00:00			`extract:`
feat: Add copy_standard_markdown parameter to plugin This parameter controls whether the standard markdown extensions will be added to the include_extensions or not. Resolves #1. 2021-01-08 18:40:06 +00:00			`replace: [['^(.)<!-- repo: -->.<!-- site:(.?) -->(.\s*)$', '\1\2\3']]`
chore: Update to latest mkdocs-simple 3.2.0 (#25) Reviewed-on: https://code.studioinfinity.org/glen/mkdocs-semiliterate/pulls/25 Co-authored-by: Glen Whitney <glen@studioinfinity.org> Co-committed-by: Glen Whitney <glen@studioinfinity.org> 2024-09-16 02:34:34 +00:00			`ensurelines: false`
feat: Add `extract_standard_markdown` and `report_docs_build` parameters Also includes the bootstrap manifest, which was inadvertently '.gitignore'd. Resolves #5. 2021-01-09 18:17:34 +00:00			`semiliterate:`
refactor: Adjust again to latest 'simple' commit Now with even less code! 2021-01-15 17:44:25 +00:00			`- pattern: '\.py$'`
chore: Update to latest mkdocs-simple 3.2.0 (#25) Reviewed-on: https://code.studioinfinity.org/glen/mkdocs-semiliterate/pulls/25 Co-authored-by: Glen Whitney <glen@studioinfinity.org> Co-committed-by: Glen Whitney <glen@studioinfinity.org> 2024-09-16 02:34:34 +00:00			`extract:`
			`- start: '"""\smd'`
			`stop: '"""'`
			`- start: '#\sstart-md'`
			`stop: '#\send-md'`
			`replace: ['^# (.\s)$']`
test: add Drone tests Also includes installation and development documentation, and updates to the latest development version of mkdocs-simple-plugin. Resolves #3. 2021-01-09 16:11:30 +00:00			`- pattern: '.drone.yml'`
			`destination: 'drone_develop.md'`
refactor: Adjust again to latest 'simple' commit Now with even less code! 2021-01-15 17:44:25 +00:00			`extract:`
			`start: '### develop'`
			`stop: '^\s*###'`
			`replace: ['^# (.\s)$', '^\s-(.\s*)$']`
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. 2021-01-08 06:39:40 +00:00			`markdown_extensions:`
			`- abbr`
feat: Add copy_standard_markdown parameter to plugin This parameter controls whether the standard markdown extensions will be added to the include_extensions or not. Resolves #1. 2021-01-08 18:40:06 +00:00			`- def_list`
docs: Prepare for PyPI publication (#10) 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: https://code.studioinfinity.org/glen/mkdocs-semiliterate/pulls/10 Co-Authored-By: Glen Whitney <glen@nobody@nowhere.net> Co-Committed-By: Glen Whitney <glen@nobody@nowhere.net> 2021-02-09 17:47:02 +00:00			`- smarty`
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. 2021-01-08 06:39:40 +00:00			`theme:`
			`name: readthedocs`
			`docs_dir: mkdocs_semiliterate # dummy`