Improve **Usage** section with better examples
And a more detailed introduction paragraph.
parent
27ca64be86
commit
68296eda2e
1 changed files with 28 additions and 2 deletions
30
Home.md
30
Home.md
|
@ -78,8 +78,15 @@ ### Change Default Format
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
After successful [installation](#installing), code blocks with the appropriate
|
Code blocks with the appropriate language label will be converted to an image.
|
||||||
language will now be converted to images.
|
Specifying the language of a code block depends on the template
|
||||||
|
engine—examples are provided in this section. Refer to the
|
||||||
|
[supported diagrams](#supported-diagrams) section for a list of diagram
|
||||||
|
languages.
|
||||||
|
|
||||||
|
### Markdown
|
||||||
|
|
||||||
|
For Markdown, specify the diagram language after the starting triple backticks:
|
||||||
|
|
||||||
````markdown
|
````markdown
|
||||||
```plantuml
|
```plantuml
|
||||||
|
@ -90,6 +97,25 @@ ## Usage
|
||||||
```
|
```
|
||||||
````
|
````
|
||||||
|
|
||||||
|
### HTML-Like Template Engines Such as Vento and JSX
|
||||||
|
|
||||||
|
Template engines which have HTML-like syntax can specify the language using the
|
||||||
|
`class` or `className` attribute:
|
||||||
|
|
||||||
|
```vento
|
||||||
|
<pre>
|
||||||
|
<code class="language-plantuml">
|
||||||
|
@startuml
|
||||||
|
Alice -> Bob: Hi
|
||||||
|
Bob -> Alice: Hi
|
||||||
|
@enduml
|
||||||
|
</code>
|
||||||
|
</pre>
|
||||||
|
```
|
||||||
|
|
||||||
|
> [!NOTE]
|
||||||
|
> The language name must be prefixed with `language-`.
|
||||||
|
|
||||||
## Supported Diagrams
|
## Supported Diagrams
|
||||||
|
|
||||||
A table of supported diagrams—each with their available output formats and
|
A table of supported diagrams—each with their available output formats and
|
||||||
|
|
Loading…
Reference in a new issue