Skip to content

Add configuration option to ignore files/paths #1500

@pixelbrackets

Description

@pixelbrackets

»mkdocs« converts all Markdown files to HTML and then copies all other files, except dot files and directories, into the build directory (according to my own tests and #1488 (comment)).

Is it possible to customize or append something to the ignore pattern?

Use case:

  • Project X has docs in the root directory (readme, changelog, contribution guide, etc.) - mkdocs then copies all source files into the build folder as well. Would be better to be able to ignore a src and test folder etc.

  • Project Y has to build two versions of the same documentation - one complete (eg. extended support), one with some files missing (eg. communuty edition).

Of course it is possible in both cases to remove the desired files after mkdocs completes the conversion. Depending on the size of the repository this may waste resources, which may be saved when then files are not precessed in the first place due to a »ignore« option.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions