Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4983 from adamdmharvey/doco-examples
techdocs: Update example documentation
- Loading branch information
Showing
6 changed files
with
113 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -269,6 +269,7 @@ templated | |
templater | ||
templaters | ||
theia | ||
thumbsup | ||
toc | ||
tolerations | ||
toolchain | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
82 changes: 82 additions & 0 deletions
82
plugins/techdocs-backend/examples/documented-component/docs/extensions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
# Plugins & Extensions | ||
|
||
Just by including the TechDocs Core Plugin to your MkDocs site included with Backstage, | ||
you gain the immediate use of a variety of popular plugins and extensions to MkDocs. | ||
|
||
For more information and full details of the available features, see the | ||
[`mkdocs-techdocs-core` repository](https://github.com/backstage/mkdocs-techdocs-core#mkdocs-plugins-and-extensions). | ||
|
||
This page provides a demonstration of some of the available features. | ||
|
||
## Admonitions | ||
|
||
Admonitions are call outs that help catch a users attention. | ||
|
||
To define an admonition simply put the following Markdown into your content: | ||
|
||
``` | ||
!!! warn | ||
Defining admonitions can be addicting. | ||
``` | ||
|
||
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. | ||
|
||
## PlantUML | ||
|
||
You can create dynamic UML diagrams on the fly by just specifying flow via text, | ||
using [PlantUML](https://pypi.org/project/plantuml-markdown/). | ||
|
||
```plantuml format="svg" classes="uml myDiagram" alt="Backstage sample PlantUML" title="Backstage sample PlantUML" width="500px" height="250px" | ||
User -> SCMProvider: stores | ||
TechDocs -> SCMProvider: prepares | ||
TechDocs -> TechDocs: generates | ||
TechDocs -> CloudStorage: publishes | ||
CloudStorage -> Backstage: displays | ||
``` | ||
|
||
## Pymdownx Extensions | ||
|
||
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. | ||
|
||
### Task Lists | ||
|
||
Automatic rendering of Markdown task lists. | ||
|
||
- [x] Phase 1 | ||
- [x] Phase 2 | ||
- [ ] Phase 3 | ||
|
||
### Emojis | ||
|
||
Very nice job on documentation! :thumbsup: | ||
|
||
I've read a lot of documentation, but I love :heart: this document. | ||
|
||
Weather: :sunny: :umbrella: :cloud: :snowflake: | ||
|
||
Animals: :tiger: :horse: :turtle: :wolf: :frog: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters