Skip to content

Commit bca7a2a

Browse files
committed
Update docs
- Add description list sample - Improve doc content
1 parent 505da84 commit bca7a2a

File tree

2 files changed

+27
-49
lines changed

2 files changed

+27
-49
lines changed

_posts/2019-08-08-text-and-typography.md

Lines changed: 24 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Beside the lake, beneath the trees,
3838

3939
Fluttering and dancing in the breeze.
4040

41-
## List
41+
## Lists
4242

4343
### Ordered list
4444

@@ -52,7 +52,7 @@ Fluttering and dancing in the breeze.
5252
- Setcion
5353
- Paragraph
5454

55-
### Checkbox list
55+
### Task list
5656

5757
- [ ] TODO
5858
- [x] Completed
@@ -62,26 +62,35 @@ Fluttering and dancing in the breeze.
6262
- [ ] Economic recovery
6363
- [ ] People smile again
6464

65+
### Description list
66+
67+
Sun
68+
: the star around which the earth orbits
69+
70+
Moon
71+
: the natural satellite of the earth, visible by reflected light from the sun
72+
73+
6574
## Block Quote
6675

6776
> This line to shows the Block Quote.
6877
6978
## Tables
7079

71-
| Company | contact | Country |
80+
| Company | Contact | Country |
7281
|:-----------------------------|:-----------------|--------:|
7382
| Alfreds Futterkiste | Maria Anders | Germany |
7483
| Island Trading | Helen Bennett | UK |
7584
| Magazzini Alimentari Riuniti | Giovanni Rovelli | Italy |
7685

77-
## Link
86+
## Links
7887

7988
<http://127.0.0.1:4000>
8089

8190

8291
## Footnote
8392

84-
Click the hook will locate the footnote[^footnote].
93+
Click the hook will locate the footnote[^footnote], and here is another footnote[^fn-nth-2].
8594

8695

8796
## Images
@@ -130,9 +139,6 @@ _400px image width_
130139
cherry :active, c, after b a, 1d
131140
```
132141

133-
## Inline code
134-
135-
This is an example of `Inline Code`.
136142

137143
## Mathematics
138144

@@ -144,7 +150,13 @@ When \\(a \ne 0\\), there are two solutions to \\(ax^2 + bx + c = 0\\) and they
144150

145151
$$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$
146152

147-
## Code Snippet
153+
154+
## Inline code
155+
156+
This is an example of `Inline Code`.
157+
158+
159+
## Code block
148160

149161
### Common
150162

@@ -157,14 +169,6 @@ This is a common code snippet, without syntax highlight and line number.
157169
#### Console
158170

159171
```console
160-
$ date
161-
Sun Nov 3 15:11:12 CST 2019
162-
```
163-
164-
165-
#### Terminal
166-
167-
```terminal
168172
$ env |grep SHELL
169173
SHELL=/usr/local/bin/bash
170174
PYENV_SHELL=bash
@@ -198,44 +202,18 @@ fi;
198202
```
199203
{% endraw %}
200204

201-
#### Html
202-
203-
```html
204-
<div class="sidenav">
205-
<a href="#contact">Contact</a>
206-
<button class="dropdown-btn">Dropdown
207-
<i class="fa fa-caret-down"></i>
208-
</button>
209-
<div class="dropdown-container">
210-
<a href="#">Link 1</a>
211-
<a href="#">Link 2</a>
212-
<a href="#">Link 3</a>
213-
</div>
214-
<a href="#contact">Search</a>
215-
</div>
216-
```
217-
218205
#### Java
219206

220207
```java
221208
private void writeObject(java.io.ObjectOutputStream s)
222209
throws java.io.IOException {
223210
// Write out any hidden serialization magic
224211
s.defaultWriteObject();
225-
226-
// Write out HashMap capacity and load factor
227-
s.writeInt(map.capacity());
228-
s.writeFloat(map.loadFactor());
229-
230-
// Write out size
231-
s.writeInt(map.size());
232-
233-
// Write out all elements in the proper order.
234-
for (E e: map.keySet())
235-
s.writeObject(e);
212+
for (E e: map.keySet()) s.writeObject(e);
236213
}
237214
```
238215

239216
## Reverse Footnote
240217

241-
[^footnote]: The footnote source.
218+
[^footnote]: The footnote source
219+
[^fn-nth-2]: The 2nd footnote source

_posts/2019-08-08-write-a-new-post.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ mermaid: true
7878
---
7979
```
8080

81-
Then you can use it like other markdown language: surround the graph code with <code class="highlighter-rouge">```mermaid</code>.
81+
Then you can use it like other markdown language: surround the graph code with ```` ```mermaid ```` and ```` ``` ````.
8282

8383
## Images
8484

@@ -147,15 +147,15 @@ pin: true
147147

148148
## Code Block
149149

150-
Markdown symbols <code class="highlighter-rouge">```</code> can easily create a code block as following examples.
150+
Markdown symbols ```` ``` ```` can easily create a code block as following examples.
151151

152152
```
153153
This is a common code snippet, without syntax highlight and line number.
154154
```
155155
156156
## Specific Language
157157
158-
Using <code class="highlighter-rouge">```language</code> you will get code snippets with line numbers and syntax highlight.
158+
Using ```` ```language ```` you will get code snippets with line numbers and syntax highlight.
159159
160160
> **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 !
161161

0 commit comments

Comments
 (0)