Skip to content
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

[techdocs] Use gh-admonitions plugin everywhere #657

Open
iainlane opened this issue Dec 17, 2024 · 0 comments
Open

[techdocs] Use gh-admonitions plugin everywhere #657

iainlane opened this issue Dec 17, 2024 · 0 comments

Comments

@iainlane
Copy link
Member

The gh-admonitions plugin was added to the shared workflow in 7973f46

It's not ideal that individual repositories have to add this to their config. This ought to be something that works out ouf the box.

The @techdocs/cli script has a flag:

Usage: techdocs-cli generate|build [options]

Generate TechDocs documentation site using MkDocs.

Options:
  ...
  --defaultPlugin [defaultPlugins...]  Plugins which should be added automatically to the mkdocs.yaml file (default: [])
  ...

which might be able to be used for this purpose, if it works like it sounds.

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

No branches or pull requests

1 participant