Skip to content

Commit

Permalink
docs: add filename usage for code blocks
Browse files Browse the repository at this point in the history
fix #43
  • Loading branch information
esoubiran-aneo committed Jun 23, 2023
1 parent fc60c9d commit 29abc63
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions content/1.guide/3.writing.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,18 @@ And you can use inline components to props to `span`or to use an icon.
More information about the MDC syntax can be found in the [MDC documentation](https://content.nuxtjs.org/guide/writing/mdc#mdc-syntax).
::

::alert{type="info"}
For code block, we recommend you to add a filename or the terminal name to give a better understanding to the reader.

```
\```md [index.md]
<!-- ... -->
\```
```

You can see a text between `[` and `]` in the code block. This is the filename.
::

#### Mermaid

You can use [Mermaid](https://mermaid-js.github.io/mermaid/#/) to create diagrams.
Expand Down

0 comments on commit 29abc63

Please sign in to comment.