Skip to content

Commit

Permalink
docs: update Mermaid name and URLs, fix grammar (#1994)
Browse files Browse the repository at this point in the history
  • Loading branch information
gy-mate authored Jan 2, 2025
1 parent 19f23c0 commit 9f7f6f4
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Presentation <b>slide</b>s for <b>dev</b>elopers 🧑‍💻👩‍💻👨‍
- 🎙 [**Presenter Mode**](https://sli.dev/guide/ui#presenter-mode) - use another window, or even your phone to control your slides
- 🎨 [**Drawing**](https://sli.dev/features/drawing) - draw and annotate on your slides
- 🧮 [**LaTeX**](https://sli.dev/features/latex) - built-in LaTeX math equations support
- 📰 [**Diagrams**](https://sli.dev/guide/syntax#diagrams) - creates diagrams using textual descriptions with [Mermaid.js](https://mermaid.js.org/)
- 📰 [**Diagrams**](https://sli.dev/guide/syntax#diagrams) - creates diagrams using textual descriptions with [Mermaid](https://mermaid.js.org/)
- 🌟 [**Icons**](https://sli.dev/features/icons) - access to icons from any icon set directly
- 💻 [**Editor**](https://sli.dev/guide/index#editor) - integrated editor, or the [VSCode extension](https://sli.dev/features/vscode-extension)
- 🎥 [**Recording**](https://sli.dev/features/recording) - built-in recording and camera view
Expand Down
2 changes: 1 addition & 1 deletion docs/custom/config-mermaid.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export default defineMermaidSetup(() => {
})
```

The return value should be the custom configs for [Mermaid.js](https://mermaid.js.org/). Refer to the [Mermaid's documentation](http://mermaid.js.org/config/schema-docs/config.html) or the type definition for the full config list.
The return value should be the custom configs for [Mermaid](https://mermaid.js.org/). Refer to the [Mermaid documentation](https://mermaid.js.org/config/schema-docs/config.html) or the type definition for the full config list.

## Custom theme/styles

Expand Down
8 changes: 4 additions & 4 deletions docs/features/mermaid.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
relates:
- Mermaid: http://mermaid.js.org/
- Mermaid: https://mermaid.js.org/
- Mermaid Live Editor: https://mermaid.live/
- Demo Slide: https://sli.dev/demo/starter/12
- features/plantuml
Expand All @@ -9,9 +9,9 @@ description: |
Create diagrams/graphs from textual descriptions, powered by Mermaid.
---

# Mermaid.js Diagrams
# Mermaid Diagrams

You can also create diagrams/graphs from textual descriptions in your Markdown, powered by [Mermaid](https://mermaid-js.github.io/mermaid).
You can also create diagrams/graphs from textual descriptions in your Markdown, powered by [Mermaid](https://mermaid.js.org/).

Code blocks marked as `mermaid` will be converted to diagrams, for example:

Expand All @@ -34,4 +34,4 @@ C -->|Two| E[Result 2]
```
````

Visit the [Mermaid Website](http://mermaid.js.org/) for more information.
Visit the [Mermaid Website](https://mermaid.js.org/) for more information.
2 changes: 1 addition & 1 deletion docs/guide/syntax.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Slidev supports LaTeX blocks for mathematical and chemical formulas:

## Diagrams {#diagrams}

Slidev supports [Mermaid.js](http://mermaid.js.org/) and [PlantUML](https://plantuml.com/) for creating diagrams from text:
Slidev supports [Mermaid](https://mermaid.js.org/) and [PlantUML](https://plantuml.com/) for creating diagrams from text:

<LinkCard link="features/mermaid" />
<LinkCard link="features/plantuml" />
Expand Down

0 comments on commit 9f7f6f4

Please sign in to comment.