-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Some more minor fixes for KB initial commit
- Loading branch information
Showing
2 changed files
with
41 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
This is a file to test embedded diagrams. | ||
|
||
|
||
``` plantuml | ||
@startuml | ||
digraph foo { | ||
node [style=rounded] | ||
node1 [shape=box] | ||
node2 [fillcolor=yellow, style="rounded,filled", shape=diamond] | ||
node3 [shape=record, label="{ a | b | c }"] | ||
node1 -> node2 -> node3 | ||
}; | ||
@enduml | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Working with the KB | ||
|
||
This KB is mostly `Markdown`, but it has embedded 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). | ||
If your editor supports this, and everything is configured correctly, | ||
you should see a rendered charts. | ||
|
||
Here are two options you can use to work with this KB | ||
|
||
## PyCharm | ||
|
||
- Install `graphviz`. | ||
- Install and enable the Markdown plugin in PyCharm. | ||
|
||
In theory this should be enough, but you may find that charts give you a rendering error | ||
about not finding "dot". | ||
In this case find the `dot` executable in your system and copy it to `/opt/local/bin/dot`. | ||
It should work now. | ||
|
||
## Obsidian | ||
|
||
- Install the `Obsidian` app | ||
- Install the PlantUML plugin in Obsidian. | ||
You might need to configure the path to the dot executable. |