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

Wrap lines

Browse Source 
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
This commit is contained in:
Adam Harvey
2021-03-16 22:50:12 -04:00
parent 74e0e12e41
commit 8efa047a6b
3 changed files with 18 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/techdocs-backend/examples/documented-component/docs/extensions.md
+10 -5
View File
@@ -1,8 +1,10 @@
# 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.
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).
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.
@@ -23,7 +25,8 @@ And they end up looking like this:
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.
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.
@@ -33,7 +36,8 @@ 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/).
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
@@ -56,7 +60,8 @@ The answer is 42.
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.
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
plugins/techdocs-backend/examples/documented-component/docs/index.md
+6 -3
View File
@@ -1,6 +1,7 @@
# Welcome!
This is a basic example of documentation. It is intended as a showcase of some of the features that TechDocs provides out of the box.
This is a basic example of documentation. It is intended as a showcase of some of the
features that TechDocs provides out of the box.
You can see also:
@@ -16,7 +17,8 @@ Here is a bulleted list:
- Item two
- Item Three
Check out the [Markdown Guide](https://www.markdownguide.org/) to learn more about how to simply create documentation.
Check out the [Markdown Guide](https://www.markdownguide.org/) to learn more about how to
simply create documentation.
You can also learn more about how to configure and setup this documentation in Backstage,
[read up on the TechDocs Overview](https://backstage.io/docs/features/techdocs/techdocs-overview).
@@ -29,7 +31,8 @@ This documentation is powered by Backstage's TechDocs feature:
## Table Example
While this documentation isn't comprehensive, in the future it should cover the following topics outlined in this example table:
While this documentation isn't comprehensive, in the future it should cover the following
topics outlined in this example table:
| Topic | Description |
| ------- | ------------------------------------------------------------ |
plugins/techdocs-backend/examples/documented-component/docs/sub-page.md
+2 -1
View File
@@ -4,7 +4,8 @@ This sub-page can be used to elaborate on a specific part of the component.
## Details
It is linked off the main page, and due to its inclusion in the `mkdocs.yml` file, becomes part of the auto-generated site navigation.
It is linked off the main page, and due to its inclusion in the `mkdocs.yml` file,
becomes part of the auto-generated site navigation.
## MkDocs