1
0
mirror of https://github.com/cotes2020/jekyll-theme-chirpy.git synced 2025-12-18 05:41:31 +00:00

Update docs

-  Add description list sample
-  Improve doc content
This commit is contained in:
Cotes Chung
2020-12-26 00:22:30 +08:00
parent 505da84a26
commit bca7a2a634
2 changed files with 27 additions and 49 deletions

View File

@@ -78,7 +78,7 @@ mermaid: true
---
```
Then you can use it like other markdown language: surround the graph code with <code class="highlighter-rouge">```mermaid</code>.
Then you can use it like other markdown language: surround the graph code with ```` ```mermaid ```` and ```` ``` ````.
## Images
@@ -147,7 +147,7 @@ pin: true
## Code Block
Markdown symbols <code class="highlighter-rouge">```</code> can easily create a code block as following examples.
Markdown symbols ```` ``` ```` can easily create a code block as following examples.
```
This is a common code snippet, without syntax highlight and line number.
@@ -155,7 +155,7 @@ This is a common code snippet, without syntax highlight and line number.
## Specific Language
Using <code class="highlighter-rouge">```language</code> you will get code snippets with line numbers and syntax highlight.
Using ```` ```language ```` you will get code snippets with line numbers and syntax highlight.
> **Note**: The Jekyll style `{% raw %}{%{% endraw %} highlight LANGUAGE {% raw %}%}{% endraw %}` or `{% raw %}{%{% endraw %} highlight LANGUAGE linenos {% raw %}%}{% endraw %}` are not allowed to be used in this theme !