From 5644ed7fafc4e0685467c236e37e60c5dd28eb14 Mon Sep 17 00:00:00 2001 From: Arne Rossmann <54142498+arnerossmann@users.noreply.github.com> Date: Thu, 13 Feb 2025 19:41:39 +0100 Subject: [PATCH 1/3] Create catalog-info.yaml --- examples/docs-template/catalog-info.yaml | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 examples/docs-template/catalog-info.yaml diff --git a/examples/docs-template/catalog-info.yaml b/examples/docs-template/catalog-info.yaml new file mode 100644 index 00000000..f040d205 --- /dev/null +++ b/examples/docs-template/catalog-info.yaml @@ -0,0 +1,12 @@ +apiVersion: backstage.io/v1alpha1 +kind: Component +metadata: + name: docs-template + description: lorem ipsum + annotations: + github.com/project-slug: arnerossmann software-templates + backstage.io/techdocs-ref: dir:. +spec: + type: documentation + lifecycle: experimental + owner: arnerossmann From fa0c7c6dea1f27dbd6a89f16c9184784dc1defa6 Mon Sep 17 00:00:00 2001 From: Arne Rossmann <54142498+arnerossmann@users.noreply.github.com> Date: Thu, 13 Feb 2025 19:42:35 +0100 Subject: [PATCH 2/3] Create mkdocs.yml --- examples/docs-template/mkdocs.yml | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 examples/docs-template/mkdocs.yml diff --git a/examples/docs-template/mkdocs.yml b/examples/docs-template/mkdocs.yml new file mode 100644 index 00000000..e7d92734 --- /dev/null +++ b/examples/docs-template/mkdocs.yml @@ -0,0 +1,7 @@ +site_name: docs-template +site_description: lorem ipsum +nav: + - Introduction: index.md + +plugins: + - techdocs-core From d5f237a604bcb4e401c7f108396c78ff5f898919 Mon Sep 17 00:00:00 2001 From: Arne Rossmann <54142498+arnerossmann@users.noreply.github.com> Date: Thu, 13 Feb 2025 19:43:18 +0100 Subject: [PATCH 3/3] Create index.md --- examples/docs-template/docs/index.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 examples/docs-template/docs/index.md diff --git a/examples/docs-template/docs/index.md b/examples/docs-template/docs/index.md new file mode 100644 index 00000000..154f01dd --- /dev/null +++ b/examples/docs-template/docs/index.md @@ -0,0 +1,28 @@ +## docs-template + +lorem-ipsum + +## Getting started + +Start write your documentation by adding more markdown (.md) files to this folder (/docs) or replace the content in this file. + +## Table of Contents + +The Table of Contents on the right is generated automatically based on the hierarchy +of headings. Only use one H1 (`#` in Markdown) per file. + +## Site navigation + +For new pages to appear in the left hand navigation you need edit the `mkdocs.yml` +file in root of your repo. The navigation can also link out to other sites. + +Alternatively, if there is no `nav` section in `mkdocs.yml`, a navigation section +will be created for you. However, you will not be able to use alternate titles for +pages, or include links to other sites. + +Note that MkDocs uses `mkdocs.yml`, not `mkdocs.yaml`, although both appear to work. +See also . + +## Support + +That's it. If you need support, reach out in [#docs-like-code](https://discord.com/channels/687207715902193673/714754240933003266) on Discord.