Skip to content

Specify additional files to include when publishing to gh-pages #1488

@robfletcher

Description

@robfletcher

In the root of my repository I have .circleci/config.yml which configures the way CircleCI builds my project. The configuration in that file tells CircleCI to ignore the gh-pages branch.

Unfortunately in order for that to work the .circleci directory has to exist on the gh-pages branch (CircleCI reads the config from whatever branch it clones) and MkDocs deletes it when I run mkdocs gh-deploy.

I tried symlinking and copying the .circleci directory into the docs directory, but MkDocs ignores anything in there starting with .. I've tried including the file in extra_templates but that blows up as MkDocs tries to process the file. I've also tried extra_css and extra_javascript but when running mkdocs build there was no sign of a .circleci directory in the site that was built.

Is there any way I can configure MkDocs to include this sub-directory? If not, consider this a feature request!

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