diff --git a/packages/create-app/templates/next-app/examples/entities.yaml b/packages/create-app/templates/next-app/examples/entities.yaml index 447e8b1f34..cc57de8b7a 100644 --- a/packages/create-app/templates/next-app/examples/entities.yaml +++ b/packages/create-app/templates/next-app/examples/entities.yaml @@ -12,6 +12,8 @@ apiVersion: backstage.io/v1alpha1 kind: Component metadata: name: example-website + annotations: + backstage.io/techdocs-ref: dir:./example-docs spec: type: website lifecycle: experimental diff --git a/packages/create-app/templates/next-app/examples/example-docs/docs/index.md b/packages/create-app/templates/next-app/examples/example-docs/docs/index.md new file mode 100644 index 0000000000..ecd4dbd529 --- /dev/null +++ b/packages/create-app/templates/next-app/examples/example-docs/docs/index.md @@ -0,0 +1,5 @@ +# Example TechDocs page + +This is an example TechDocs page! + +The source of this documentation for the `example-website` component is found in the `examples/example-docs` directory, which is referenced from `examples/entities.yaml`. Typically the `docs` directory would live alongside the `catalog-info.yaml` file of a component instead, but in this case it is separated out to avoid cluttering the examples directory. diff --git a/packages/create-app/templates/next-app/examples/example-docs/mkdocs.yml b/packages/create-app/templates/next-app/examples/example-docs/mkdocs.yml new file mode 100644 index 0000000000..b482f45a27 --- /dev/null +++ b/packages/create-app/templates/next-app/examples/example-docs/mkdocs.yml @@ -0,0 +1,4 @@ +site_name: example-website +docs_dir: docs +plugins: + - techdocs-core