From bca7a2a634fb954131856db04cd104639f5d8c1a Mon Sep 17 00:00:00 2001 From: Cotes Chung <11371340+cotes2020@users.noreply.github.com> Date: Sat, 26 Dec 2020 00:22:30 +0800 Subject: [PATCH] Update docs - Add description list sample - Improve doc content --- _posts/2019-08-08-text-and-typography.md | 70 ++++++++---------------- _posts/2019-08-08-write-a-new-post.md | 6 +- 2 files changed, 27 insertions(+), 49 deletions(-) diff --git a/_posts/2019-08-08-text-and-typography.md b/_posts/2019-08-08-text-and-typography.md index cf80f82..12fe4b8 100644 --- a/_posts/2019-08-08-text-and-typography.md +++ b/_posts/2019-08-08-text-and-typography.md @@ -38,7 +38,7 @@ Beside the lake, beneath the trees, Fluttering and dancing in the breeze. -## List +## Lists ### Ordered list @@ -52,7 +52,7 @@ Fluttering and dancing in the breeze. - Setcion - Paragraph -### Checkbox list +### Task list - [ ] TODO - [x] Completed @@ -62,26 +62,35 @@ Fluttering and dancing in the breeze. - [ ] Economic recovery - [ ] People smile again +### Description list + +Sun +: the star around which the earth orbits + +Moon +: the natural satellite of the earth, visible by reflected light from the sun + + ## Block Quote > This line to shows the Block Quote. ## Tables -| Company | contact | Country | +| Company | Contact | Country | |:-----------------------------|:-----------------|--------:| | Alfreds Futterkiste | Maria Anders | Germany | | Island Trading | Helen Bennett | UK | | Magazzini Alimentari Riuniti | Giovanni Rovelli | Italy | -## Link +## Links ## Footnote -Click the hook will locate the footnote[^footnote]. +Click the hook will locate the footnote[^footnote], and here is another footnote[^fn-nth-2]. ## Images @@ -130,9 +139,6 @@ _400px image width_ cherry :active, c, after b a, 1d ``` -## Inline code - -This is an example of `Inline Code`. ## Mathematics @@ -144,7 +150,13 @@ When \\(a \ne 0\\), there are two solutions to \\(ax^2 + bx + c = 0\\) and they $$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$ -## Code Snippet + +## Inline code + +This is an example of `Inline Code`. + + +## Code block ### Common @@ -157,14 +169,6 @@ This is a common code snippet, without syntax highlight and line number. #### Console ```console -$ date -Sun Nov 3 15:11:12 CST 2019 -``` - - -#### Terminal - -```terminal $ env |grep SHELL SHELL=/usr/local/bin/bash PYENV_SHELL=bash @@ -198,23 +202,6 @@ fi; ``` {% endraw %} -#### Html - -```html -
- Contact - - - Search -
-``` - #### Java ```java @@ -222,20 +209,11 @@ private void writeObject(java.io.ObjectOutputStream s) throws java.io.IOException { // Write out any hidden serialization magic s.defaultWriteObject(); - - // Write out HashMap capacity and load factor - s.writeInt(map.capacity()); - s.writeFloat(map.loadFactor()); - - // Write out size - s.writeInt(map.size()); - - // Write out all elements in the proper order. - for (E e: map.keySet()) - s.writeObject(e); + for (E e: map.keySet()) s.writeObject(e); } ``` ## Reverse Footnote -[^footnote]: The footnote source. +[^footnote]: The footnote source +[^fn-nth-2]: The 2nd footnote source diff --git a/_posts/2019-08-08-write-a-new-post.md b/_posts/2019-08-08-write-a-new-post.md index 01cdad4..8cb91c9 100644 --- a/_posts/2019-08-08-write-a-new-post.md +++ b/_posts/2019-08-08-write-a-new-post.md @@ -78,7 +78,7 @@ mermaid: true --- ``` -Then you can use it like other markdown language: surround the graph code with ```mermaid. +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 ``` 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 ```language 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 !