Skip to content

Merge already existing mkdocs.yml config with techdocs-core config instead of override #3017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
emmaindal opened this issue Oct 21, 2020 · 0 comments · Fixed by #3199
Closed
Labels
area:techdocs Related to the TechDocs Project Area priority:contrib-needed Help/Contributions wanted from community members type:suggestion New feature or request

Comments

@emmaindal
Copy link
Member

emmaindal commented Oct 21, 2020

Currently, the techdocs-core plugin overrides the markdown extension configs and set the new configs instead of taking the already existing configuration (in mkdocs.yml) and merge the two ones together.

This means if, for example I want to add toc_depth as configuration to my table of contents, I could add this to my mkdocs.yml file

markdown_extensions:
  - toc:
      toc_depth: 3

but this will be overridden by the configs set in the techdocs-core plugin.

Feature Suggestion

Merge the already existing config in the mkdocs.yml file with the config set in the techdocs-core plugin.

@emmaindal emmaindal added type:suggestion New feature or request area:techdocs Related to the TechDocs Project Area priority:contrib-needed Help/Contributions wanted from community members labels Oct 21, 2020
@emmaindal emmaindal changed the title Merge already existing mkdocs.yaml config with techdocs-core config instead of override Merge already existing mkdocs.yml config with techdocs-core config instead of override Oct 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:techdocs Related to the TechDocs Project Area priority:contrib-needed Help/Contributions wanted from community members type:suggestion New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant