diff --git a/.prettierignore b/.prettierignore index e2dcb9adc9..c4e675a5d7 100644 --- a/.prettierignore +++ b/.prettierignore @@ -7,4 +7,3 @@ templates plugins/scaffolder-backend/sample-templates .vscode dist-types -plugins/techdocs-backend/examples/documented-component/docs diff --git a/plugins/techdocs-backend/examples/documented-component/docs/extensions.md b/plugins/techdocs-backend/examples/documented-component/docs/extensions.md index 55152628eb..40565bd42f 100644 --- a/plugins/techdocs-backend/examples/documented-component/docs/extensions.md +++ b/plugins/techdocs-backend/examples/documented-component/docs/extensions.md @@ -21,16 +21,20 @@ To define an admonition simply put the following Markdown into your content: And they end up looking like this: + !!! warn Defining admonitions can be addicting. + !!! note You can learn a lot about TechDocs by just visiting the Backstage web site at https://backstage.io/docs. + !!! info TechDocs is the core feature that supports documentation as code in Backstage. + !!! tip Don't forget to spell check your documentation. @@ -53,12 +57,15 @@ Pymdownx (Python Markdown extensions) are a variety of smaller additions. ### Details + ??? note "What is the answer to life, the universe, and everything? (click me for the answer)" The answer is 42. + ??? note "What is 4 plus 4?" The answer is 8. + ???+ note "How do I get support?" You can get support by opening an issue in this repository. This detail is open by default so it's more easily visible without requiring the user to click to open it.