Skip to content

Commit

Permalink
chore: add mermaid diagram support (#3499)
Browse files Browse the repository at this point in the history
Adding mermaid diagram support for the yellow-paper. 

# Checklist:
Remove the checklist to signal you've completed it. Enable auto-merge if
the PR is ready to merge.
- [ ] If the pull request requires a cryptography review (e.g.
cryptographic algorithm implementations) I have added the 'crypto' tag.
- [ ] I have reviewed my diff in github, line by line and removed
unexpected formatting changes, testing logs, or commented-out code.
- [ ] Every change is related to the PR description.
- [ ] I have
[linked](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)
this pull request to relevant issues (if any exist).
  • Loading branch information
LHerskind authored Dec 1, 2023
1 parent 97c40c2 commit 537d552
Show file tree
Hide file tree
Showing 3 changed files with 435 additions and 6 deletions.
5 changes: 5 additions & 0 deletions yellow-paper/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ const config = {
locales: ["en"],
},

markdown: {
mermaid: true,
},
themes: ["@docusaurus/theme-mermaid"],

presets: [
[
"classic",
Expand Down
1 change: 1 addition & 0 deletions yellow-paper/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
"dependencies": {
"@docusaurus/core": "2.4.3",
"@docusaurus/preset-classic": "2.4.3",
"@docusaurus/theme-mermaid": "^2.4.3",
"@mdx-js/react": "^1.6.22",
"clsx": "^1.2.1",
"prism-react-renderer": "^1.3.5",
Expand Down
Loading

0 comments on commit 537d552

Please sign in to comment.