From 52fff5ed0be098ddf95d6eedfaad30bf1fe0f3f2 Mon Sep 17 00:00:00 2001 From: Antonino Provenzano Date: Tue, 14 Nov 2023 10:49:21 +0100 Subject: [PATCH] Update how-to-guides.md Added new section in doc, to prevent download of Google fonts Signed-off-by: Antonino Provenzano --- docs/features/techdocs/how-to-guides.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/features/techdocs/how-to-guides.md b/docs/features/techdocs/how-to-guides.md index 29f985904f..8415640569 100644 --- a/docs/features/techdocs/how-to-guides.md +++ b/docs/features/techdocs/how-to-guides.md @@ -483,6 +483,8 @@ plugins: - techdocs-core ``` +note: + 3. Create a `/docs` folder in the skeleton folder with at least an `index.md` file in it. @@ -504,6 +506,18 @@ folder (/docs) or replace the content in this file. Done! You now have support for TechDocs in your own software template! +### Prevent download of Google fonts + +If your Backstage instance does not have internet access, the generation will fail. TechDocs tries to download the Roboto font from Google. You can disable it by adding the following lines to mkdocs.yaml: + +```markdown +theme: + name: material + font: false +``` + +note: The addition "name material" is necessary. Otherwise it will not work + ## How to enable iframes in TechDocs TechDocs uses the [DOMPurify](https://github.com/cure53/DOMPurify) library to