Merge pull request #5090 from SDA-SE/feat/example-docs

Different workaround for prettier issue with markdown files
This commit is contained in:
Eric Peterson
2021-03-24 22:40:04 +01:00
committed by GitHub
2 changed files with 7 additions and 1 deletions
-1
View File
@@ -7,4 +7,3 @@ templates
plugins/scaffolder-backend/sample-templates
.vscode
dist-types
plugins/techdocs-backend/examples/documented-component/docs
@@ -21,16 +21,20 @@ To define an admonition simply put the following Markdown into your content:
And they end up looking like this:
<!-- prettier-ignore -->
!!! warn
Defining admonitions can be addicting.
<!-- prettier-ignore -->
!!! note
You can learn a lot about TechDocs by just visiting the Backstage web site at
https://backstage.io/docs.
<!-- prettier-ignore -->
!!! info
TechDocs is the core feature that supports documentation as code in Backstage.
<!-- prettier-ignore -->
!!! tip
Don't forget to spell check your documentation.
@@ -53,12 +57,15 @@ Pymdownx (Python Markdown extensions) are a variety of smaller additions.
### Details
<!-- prettier-ignore -->
??? note "What is the answer to life, the universe, and everything? (click me for the answer)"
The answer is 42.
<!-- prettier-ignore -->
??? note "What is 4 plus 4?"
The answer is 8.
<!-- prettier-ignore -->
???+ 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.