Skip to content

Commit

Permalink
[sdk docs] Added mermaid ref (MystenLabs#19528)
Browse files Browse the repository at this point in the history
## Description 

Was unable to build site locally to test. Trying to get mermaid graph to
render here: https://sdk.mystenlabs.com/typedoc/index.html

## Test plan 


https://sui-typescript-docs-7fcypvvd6-mysten-labs.vercel.app/typedoc/index.html

---

## Release notes

Check each box that your changes affect. If none of the boxes relate to
your changes, release notes aren't required.

For each box you select, include information after the relevant heading
that describes the impact of your changes that a user might notice and
any actions they must take to implement updates.

- [ ] Protocol: 
- [ ] Nodes (Validators and Full nodes): 
- [ ] Indexer: 
- [ ] JSON-RPC: 
- [ ] GraphQL: 
- [ ] CLI: 
- [ ] Rust SDK:
- [ ] REST API:
  • Loading branch information
ronny-mysten authored Sep 26, 2024
1 parent 6d1c490 commit 98ed88d
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 21 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="https://github.com/MystenLabs/sui/blob/main/docs/site/static/img/logo.svg" alt="Logo" width="100" height="100">
<img src="https://raw.githubusercontent.com/MystenLabs/sui/refs/heads/main/docs/site/static/img/logo.svg" alt="Logo" width="100" height="100">
</p>

# Welcome to Sui
Expand Down
75 changes: 57 additions & 18 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion sdk/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@
"nextra": "^2.13.4",
"nextra-theme-docs": "^2.13.4",
"react": "^18.3.1",
"react-dom": "^18.3.1"
"react-dom": "^18.3.1",
"typedoc-plugin-mermaid": "^1.12.0"
},
"devDependencies": {
"@types/react": "^18.3.3",
Expand Down
3 changes: 2 additions & 1 deletion sdk/docs/typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,6 @@
"excludePrivate": true,
"intentionallyNotExported": [],
"out": "public/typedoc",
"entryPointStrategy": "packages"
"entryPointStrategy": "packages",
"plugin": ["typedoc-plugin-mermaid"]
}

0 comments on commit 98ed88d

Please sign in to comment.