From 86b8de42f9eec6c69e374d9983cd493b885d510b Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Wed, 24 May 2023 23:16:47 -0400 Subject: [PATCH] chore(docs): Fix proper case and improve wording Signed-off-by: Adam Harvey --- docs/features/techdocs/how-to-guides.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/features/techdocs/how-to-guides.md b/docs/features/techdocs/how-to-guides.md index ceccbe1468..36e53f20b5 100644 --- a/docs/features/techdocs/how-to-guides.md +++ b/docs/features/techdocs/how-to-guides.md @@ -507,16 +507,16 @@ folder (/docs) or replace the content in this file. Done! You now have support for TechDocs in your own software template! -## how to enable iframes in TechDocs +## How to enable iframes in TechDocs -Techdocs uses the [DOMPurify](https://github.com/cure53/DOMPurify) to sanitizes -HTML and prevents XSS attacks +TechDocs uses the [DOMPurify](https://github.com/cure53/DOMPurify) library to sanitize +HTML and prevent XSS attacks. It's possible to allow some iframes based on a list of allowed hosts. To do this, add the allowed hosts in the `techdocs.sanitizer.allowedIframeHosts` configuration of your `app-config.yaml` -E.g. +For example: ```yaml techdocs: @@ -525,7 +525,7 @@ techdocs: - drive.google.com ``` -This way, all iframes where the host of src attribute is in the +This way, all iframes where the host in the src attribute is in the `sanitizer.allowedIframeHosts` list will be displayed. ## How to add Mermaid support in TechDocs