[docsyserver] Add more documentation on Hugo/Docsy capabilities.
Bug: skia:11799 Change-Id: I504fd0cd65dd4dbf31d77b4b0efc692f072d94e8 No-Try: true Docs-Preview: https://skia.org/docs/dev/tools/markdown/?cl=391876 Reviewed-on: https://skia-review.googlesource.com/c/skia/+/391876 Reviewed-by: Heather Miller <hcm@google.com>
This commit is contained in:
parent
d18967c67d
commit
5fa3b130fe
@ -46,7 +46,55 @@ Docsy supports both
|
||||
[Font-Awesome](https://fontawesome.com/). Check out their documentation for what
|
||||
they offer.
|
||||
|
||||
Bootstrap contains many classes that allow you to avoid setting styles via CSS.
|
||||
For example, just using classes, we can change the font, the padding, and the
|
||||
color:
|
||||
|
||||
```html
|
||||
<p class="font-monospace p-2 text-danger">This is in monospace</p>
|
||||
```
|
||||
|
||||
Which renders as:
|
||||
|
||||
<p class="font-monospace p-2 text-danger">This is in monospace</p>
|
||||
|
||||
## Diagrams
|
||||
|
||||
[Mermaid](https://mermaid-js.github.io/mermaid/#/) diagrams are enabled, so
|
||||
this:
|
||||
|
||||
````markdown
|
||||
```mermaid
|
||||
graph TD;
|
||||
A-->B;
|
||||
A-->C;
|
||||
B-->D;
|
||||
C-->D;
|
||||
```
|
||||
````
|
||||
|
||||
Gets rendered as:
|
||||
|
||||
```mermaid
|
||||
graph TD;
|
||||
A-->B;
|
||||
A-->C;
|
||||
B-->D;
|
||||
C-->D;
|
||||
```
|
||||
|
||||
## Code Snippets
|
||||
|
||||
To get syntax highlighting in code snippets you need to specify the language,
|
||||
which is specified after the first code fence, for example this is how you would
|
||||
show HTML markup:
|
||||
|
||||
````
|
||||
```html
|
||||
<p class="font-monospace p-2 text-danger">This is in monospace</p>
|
||||
```
|
||||
````
|
||||
|
||||
## Configuration
|
||||
|
||||
The Hugo configuration file is [config.toml](../../../config.toml) in the site
|
||||
directory.
|
||||
The Hugo configuration file is `config.toml` located in the site directory.
|
||||
|
Loading…
Reference in New Issue
Block a user