Skip to content

Commit

Permalink
Add sentence about live Mermaid editor to README, try to fix Mermaid …
Browse files Browse the repository at this point in the history
…styling

Signed-off-by: Diana <[email protected]>
  • Loading branch information
cloudjumpercat committed Dec 7, 2023
1 parent b864d75 commit 93f4b6c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
2 changes: 2 additions & 0 deletions WRITING-DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ This flowchart would render like the following in the docs:

![Mermaid flowchart example](/assets/images/diagrams/mermaid-example.png)

You can use [https://mermaid.live/edit](https://mermaid.live/edit) to generate diagrams and see the rendered output before adding it to docs.

**Note:** Currently, Mermaid isn't supported in navtabs.

Check warning on line 58 in WRITING-DOCUMENTATION.md

View workflow job for this annotation

GitHub Actions / Lint docs

[vale] reported by reviewdog 🐶 [Google.Colons] ': C' should be in lowercase. Raw Output: {"message": "[Google.Colons] ': C' should be in lowercase.", "location": {"path": "WRITING-DOCUMENTATION.md", "range": {"start": {"line": 58, "column": 1}}}, "severity": "WARNING"}

## Cutting a new release
Expand Down
6 changes: 5 additions & 1 deletion app/_assets/styles/custom/base/_type-and-content.scss
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,11 @@ div[class*='language-'] {
pre[class*='language-'],
div[class*='language-'] {
background-color: $codeBgColor;


&.mermaid {
background-color: unset;
}

code {
font-size: 0.9rem;
line-height: 1.5;
Expand Down

0 comments on commit 93f4b6c

Please sign in to comment.