paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 33 Packages Projects Releases Wiki Activity

Different workaround for prettier issue with markdown files

Browse Source 
Follow up for #5073

Instead of disabling prettier completely, I would prefer to disable it for the lines that actual cause issues.

Signed-off-by: Oliver Sand <oliver.sand@sda-se.com>
This commit is contained in:
Oliver Sand
2021-03-24 19:27:54 +01:00
parent eb22cf5fe6
commit 21cc2f9216
2 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/techdocs-backend/examples/documented-component/docs/extensions.md
+7
View File
@@ -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.