|
1 | 1 | ## kubernetes-netbox |
2 | 2 |
|
3 | | - |
4 | | - |
5 | 3 | ## Getting started |
6 | 4 |
|
7 | | -Start write your documentation by adding more markdown (.md) files to this folder (/docs) or replace the content in this file. |
8 | | -For more info visit [TechDoc](https://backstage.io/docs/features/techdocs/) and [TechDocs at Broad](https://backstage.broadinstitute.org/catalog/default/component/backstage/docs/techdocs/) |
| 5 | +Start write your documentation by adding more markdown (.md) files to this |
| 6 | +folder (/docs) or replace the content in this file. For more info visit |
| 7 | +[TechDoc](https://backstage.io/docs/features/techdocs/) and |
| 8 | +[TechDocs at Broad](https://backstage.broadinstitute.org/catalog/default/component/backstage/docs/techdocs/) |
9 | 9 |
|
10 | 10 | ## Table of Contents |
11 | 11 |
|
12 | | -The Table of Contents on the right is generated automatically based on the hierarchy |
13 | | -of headings. Only use one H1 (`#` in Markdown) per file. |
| 12 | +The Table of Contents on the right is generated automatically based on the |
| 13 | +hierarchy of headings. Only use one H1 (`#` in Markdown) per file. |
14 | 14 |
|
15 | 15 | ## Site navigation |
16 | 16 |
|
17 | | -For new pages to appear in the left hand navigation you need edit the `mkdocs.yml` |
18 | | -file in root of your repo. The navigation can also link out to other sites. |
| 17 | +For new pages to appear in the left hand navigation you need edit the |
| 18 | +`mkdocs.yml` file in root of your repo. The navigation can also link out to |
| 19 | +other sites. |
19 | 20 |
|
20 | | -Alternatively, if there is no `nav` section in `mkdocs.yml`, a navigation section |
21 | | -will be created for you. However, you will not be able to use alternate titles for |
22 | | -pages, or include links to other sites. |
| 21 | +Alternatively, if there is no `nav` section in `mkdocs.yml`, a navigation |
| 22 | +section will be created for you. However, you will not be able to use alternate |
| 23 | +titles for pages, or include links to other sites. |
23 | 24 |
|
24 | | -Note that MkDocs uses `mkdocs.yml`, not `mkdocs.yaml`, although both appear to work. |
25 | | -See also <https://www.mkdocs.org/user-guide/configuration/>. |
| 25 | +Note that MkDocs uses `mkdocs.yml`, not `mkdocs.yaml`, although both appear to |
| 26 | +work. See also <https://www.mkdocs.org/user-guide/configuration/>. |
26 | 27 |
|
27 | 28 | ## Support |
28 | 29 |
|
29 | | -That's it. If you need support, reach out in [#docs-like-code](https://discord.com/channels/687207715902193673/714754240933003266) on Discord. |
| 30 | +That's it. If you need support, reach out in |
| 31 | +[#docs-like-code](https://discord.com/channels/687207715902193673/714754240933003266) |
| 32 | +on Discord. |
0 commit comments