Update docs

- Add description list sample - Improve doc content
mikesnotebook · Dec 25, 2020 · a368614 · a368614
1 parent 651f9c1
commit a368614
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 49 deletions.
diff --git 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
 
 <http://127.0.0.1:4000>
 
 
 ## 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,44 +202,18 @@ fi;
 ```
 {% endraw %}
 
-#### Html
-
-```html
-<div class="sidenav">
-  <a href="#contact">Contact</a>
-  <button class="dropdown-btn">Dropdown
-    <i class="fa fa-caret-down"></i>
-  </button>
-  <div class="dropdown-container">
-    <a href="#">Link 1</a>
-    <a href="#">Link 2</a>
-    <a href="#">Link 3</a>
-  </div>
-  <a href="#contact">Search</a>
-</div>
-```
-
 #### Java
 
 ```java
 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
@@ -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,15 +147,15 @@ 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.
 ```
 
 ## 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 !