Skip to content

Raise error when mkdocs-monorepo-plugin is loaded before this plugin #34

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
timvink opened this issue Jun 5, 2020 · 1 comment
Closed
Labels
enhancement New feature or request

Comments

@timvink
Copy link
Owner

timvink commented Jun 5, 2020

This plugin uses the config["docs_dir"] to find the .git folder. The monorepo plugin changes the docs_dir to a temporary folder. More context here backstage/mkdocs-monorepo-plugin#13 (comment)

We should raise an instructional error to change the plugin order in mkdocs.yml, so this plugin is always loaded first.

Examples:

Good:

plugins:
  - git-revision-date-localized
  - monorepo

Bad:

plugins:
  - monorepo
  - git-revision-date-localized
@timvink
Copy link
Owner Author

timvink commented Sep 16, 2020

#41 will solve this, as repo will be determined per not using config["docs_dir"] but page.file.abs_src_path instead.

@timvink timvink closed this as completed Sep 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant