mkdocs-semiliterate/tests/fixtures/extract-inclusion/mkdocs.yml
Glen Whitney 9d75fefb81
All checks were successful
continuous-integration/drone/push Build is passing
continuous-integration/drone/pr Build is passing
feat: Add extract_on_copy option
Previously, mkdocs_semiliterate would always attempt to extract documentation
  from a file, even if it matched the `include_extensions` pattern for files to
  be copied to the documentation site verbatim.

  Now, by default, such files are not considered candidates for extraction,
  even if they match a semiliterate pattern.

  Adds a configuration option `extract_on_copy` which can be set to `true` to
  restore the prior behavior. Also adds tests for the behavior with and without
  `extract_on_copy` and makes all `mkdocs build` commands in the tests strict,
  which they always should have been.

  Resolves #17.
2022-07-12 12:14:41 -07:00

13 lines
332 B
YAML

site_name: Enable extraction from included files
docs_dir: refsite # dummy
plugins:
- semiliterate:
ignore_folders: [refsite]
merge_docs_dir: false
include_extensions: ['.txt']
extract_on_copy: true
semiliterate:
- pattern: '\.txt'
extract: {start: '---', stop: '---'}
destination: 'polished.md'