From 15854329cdf27f39107fde071b0e485d0dd88cfc Mon Sep 17 00:00:00 2001 From: Grigory Statsenko Date: Fri, 17 Nov 2023 14:46:02 +0100 Subject: [PATCH] Minor updates for KB (#108) --- kb/index.md | 3 ++- kb/using_kb.md | 5 +++-- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/kb/index.md b/kb/index.md index 4d64a2fb6..0cd32f282 100644 --- a/kb/index.md +++ b/kb/index.md @@ -2,5 +2,6 @@ Welcome to the KB! -See: +Topics: +- [Working with this KB](using_kb.md) (editor configuration) - [Repository tooling](tooling/index.md) diff --git a/kb/using_kb.md b/kb/using_kb.md index a160ec945..709cc60bd 100644 --- a/kb/using_kb.md +++ b/kb/using_kb.md @@ -1,6 +1,6 @@ # Working with the KB -This KB is mostly `Markdown`, but it has embedded charts. +This KB is mostly `Markdown`, but it has embedded PlantUML charts. These usually don't work out-of-the-box and might require a little additional configuration. To check the correect rendering of embedded charts open [this file](test_embeds.md). @@ -22,5 +22,6 @@ It should work now. ## Obsidian - Install the `Obsidian` app -- Install the PlantUML plugin in Obsidian. +- Install and enable the PlantUML plugin in Obsidian. You might need to configure the path to the dot executable. +- Open the kb folder as a vault