Skip to content

Added plugin config definition #260

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

Merged
merged 1 commit into from
Mar 19, 2025
Merged

Conversation

DSmedley
Copy link
Contributor

@DSmedley DSmedley commented Mar 15, 2025

Added a plugin config definition as defined in the mkdocs dev-guide for developing a plugin. This resolves the issue where mkdocs will throw a warning when any property is passed to the techdocs-core config.

Example error when running techdocs-cli serve -v:

verbose: [mkdocs] WARNING -  Config value 'plugins': Plugin 'techdocs-core' option 'use_material_search': Unrecognised configuration name: use_material_search
verbose: [mkdocs] WARNING -  Config value 'plugins': Plugin 'techdocs-core' option 'use_pymdownx_blocks': Unrecognised configuration name: use_pymdownx_blocks

This was ran with the following plugin configurations:

plugins:
  - techdocs-core:
      use_pymdownx_blocks: true
      use_material_search: true

@dlaird-ovo
Copy link

Might need help from @awanlin 👍

@johnphilip283 johnphilip283 merged commit e22f30f into backstage:main Mar 19, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants