Skip to content

Demonstrate code for including without actually including #125

@wwarriner

Description

@wwarriner

Great plugin, this is helpful!

Our community documentation has a contributor guide. In that guide I want to show others how to use this plugin as it applies to our documentation. To do so I've included this:

  ```text
  {%
      include-markdown "../docs_include/<file>.md"
      heading-offset=<parent-section-header-level>
  %}
  ```

However, it (naturally) gets interpreted as an inclusion, which creates an error and an empty fenced code block in the rendered page.

Is there functionality to instruct mkdocs-include-markdown-plugin to ignore this particular inclusion so that I can render the contents of the fenced code block verbatim?

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions