Skip to content

Commit

Permalink
document updated
Browse files Browse the repository at this point in the history
  • Loading branch information
BHznJNs committed Feb 12, 2024
1 parent e0357af commit c985773
Show file tree
Hide file tree
Showing 13 changed files with 337 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .index/static+English+Syntax Tutorials_1
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"total":1,"current":1,"content":["Basics.md"],"directoryDescription":"# Syntax Tutorials\r\n\r\nThe Markdown format is used to writing blogs in this project. However, the Markdown syntax used in the project is slightly different from the popular [commonmark](https://commonmark.org/). Thus, the Markdown syntax tutorials that is suitable for this project is given here.\r\n\r\n- - -\r\n"}
{"total":1,"current":1,"content":["Basics.md","Media.md","Tables.md","Code Blocks.md","Collapses.md","Math Formulas.md","Independent Page.md","Charts.md"],"directoryDescription":"# Syntax Tutorials\r\n\r\nThe Markdown format is used to writing blogs in this project. However, the Markdown syntax used in the project is slightly different from the popular [commonmark](https://commonmark.org/). Thus, the Markdown syntax tutorials that is suitable for this project is given here.\r\n\r\n- - -\r\n"}
2 changes: 1 addition & 1 deletion .index/static+English_1
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"total":1,"current":1,"content":["Syntax Tutorials/","introduction.md","installation.md","First Blog.md"]}
{"total":1,"current":1,"content":["Syntax Tutorials/","Introduction.md","Installation.md","First Blog.md"]}
21 changes: 21 additions & 0 deletions static/English/Configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Configuration

PS: Rebuilding this project is necessary to apply modifications to specific items within the config file.

## Homepage

##homepage##

The URL that this project is deployed, it is used to generate blog links in ``rss.xml``. E.g. [https:\/\/bhznjns.github.io/markdown-blog-template/](https://bhznjns.github.io/markdown-blog-template/).

- - -

## Title

##title##

The title of the front view, will be shown in the tabbar of browser.

- - -


17 changes: 17 additions & 0 deletions static/English/Identification File.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Identification file

There are two identification files with special file name in the ``static`` directory.

## Directory Description

If a file named ``README.md`` or ``readme.md`` is created in the directory of ``static/`` (includes ``static/`` itself), this file will be the description file of the directory. In the front view, you will see the content of this file when you opened this directory and it will not be shown in the file list.

## Files Order Reversing

The files are defaultly ordered by their creating time, that is, the file that is latest created will be the top. However, for some situation, such as tutorial writing, it is required to sort the earliest at the top. That is the time to reverse the file order,

It is easy to reverse the order for a specific directory, just create a file named ``rev`` in the target directory.

- - -

##PS: it is required to run the command ``npm run build`` after the two identification files are created.##
4 changes: 2 additions & 2 deletions static/English/Syntax Tutorials/Basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,10 @@ $$e = mc^2$$
## Links

```markdown
<!-- External Link -->
<!-- External Links -->
[GitHub](https://github.com)
[https:\/\/github.com](https://github.com)
<!-- Internal Line -->
<!-- Internal Links -->
[English Documentation Directory](English/)
[English Syntax Tutorials Directory](English/Syntax Tutorials/)
```
Expand Down
161 changes: 161 additions & 0 deletions static/English/Syntax Tutorials/Charts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
# Charts

Use three ``!`` symbol to denote a chart.

## QRCode

```markdown
!!!qrcode
Some text
!!!
```
!!!qrcode
Some text
!!!

- - -

## Echarts

References: [https:\/\/echarts.apache.org/examples/zh/index.html](https://echarts.apache.org/examples/zh/index.html)
```markdown
!!!echarts
option = {
xAxis: {
type: 'category',
data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
},
yAxis: {
type: 'value'
},
series: [
{
data: [150, 230, 224, 218, 135, 147, 260],
type: 'line'
}
]
};
!!!
```
!!!echarts
option = {
xAxis: {
type: 'category',
data: ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
},
yAxis: {
type: 'value'
},
series: [
{
data: [150, 230, 224, 218, 135, 147, 260],
type: 'line'
}
]
};
!!!

- - -

## Flow Charts

References: [https:\/\/github.com/adrai/flowchart.js](https://github.com/adrai/flowchart.js)
```markdown
!!!flowchart
st=>start: Start Node
e=>end: End Node
st->e
!!!
```
!!!flowchart
st=>start: Start Node
e=>end: End Node
st->e
!!!

- - -

## Sequence Charts

References: [https:\/\/github.com/davidje13/SequenceDiagram](https://github.com/davidje13/SequenceDiagram)
```markdown
!!!sequence-chart
title "Sequence Chart Example"

甲 -> 乙
乙 -> 甲

terminators box
!!!
```
!!!sequence-chart
title "Sequence Chart Example"

甲 -> 乙
乙 -> 甲

terminators box
!!!

- - -

## Gantt Charts

References: [https:\/\/github.com/frappe/gantt](https://github.com/frappe/gantt)
```markdown
!!!gantt-chart
{
id: 'Task 1',
name: 'Task Content',
start: '2024-02-05',
end: '2024-02-20',
progress: 40,
},
{
id: 'Task 2',
name: 'Other task content',
start: '2024-02-08',
end: '2024-02-23',
progress: 20,
dependencies: 'Task 1',
}
!!!
```
!!!gantt-chart
{
id: 'Task 1',
name: 'Task Content',
start: '2024-02-05',
end: '2024-02-20',
progress: 40,
},
{
id: 'Task 2',
name: 'Other task content',
start: '2024-02-08',
end: '2024-02-23',
progress: 20,
dependencies: 'Task 1',
}
!!!

- - -

## Railroad Charts

References: [https:\/\/github.com/tabatkins/railroad-diagrams/blob/gh-pages/README-js.md](https://github.com/tabatkins/railroad-diagrams/blob/gh-pages/README-js.md)
```markdown
!!!railroad-chart
Diagram(
Choice(0,
NonTerminal("Choice 1"),
NonTerminal("Choice 2")))
!!!
```
!!!railroad-chart
Diagram(
Choice(0,
NonTerminal("Choice 1"),
NonTerminal("Choice 2")))
!!!

25 changes: 25 additions & 0 deletions static/English/Syntax Tutorials/Code Blocks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Code Blocks

Use three {``\```}(Back quote) symbol to wrap (To prevent syntax conflict, a space is added to every line).

```markdown
```
some code
```
```
```
some code
```

- - -

Add the programming language name after the three back quote to apply the code highlighting. Use ``plaintext``, ``text`` or leave it a space to denote the plain text.

```markdown
```python
print("Hello World!")
```
```
```python
print("Hello World!")
```
13 changes: 13 additions & 0 deletions static/English/Syntax Tutorials/Collapses.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Collapses

Use three ``>`` symbol to denote collapse block.

```markdown
>>>This is a collapse.
Content in a collapse.
>>>
```
>>>This is a collapse.
Content in a collapse.
>>>
19 changes: 19 additions & 0 deletions static/English/Syntax Tutorials/Independent Page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Independent Page Embedded

You can embed another webpages by their links:
```markdown
@[External Link](https://www.w3.org/)
@[Internal Link](.resources/test.html)
```
@[External Link](https://www.w3.org/)
@[Internal Link](.resources/test.html)

You can also write HTML code in markdown file:
```markdown
@@@
<h1>Test</h1>
@@@
```
@@@
<h1>Test</h1>
@@@
33 changes: 33 additions & 0 deletions static/English/Syntax Tutorials/Math Formulas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Math Formulas

## Inline Formulas

Use two ``$`` symbol to wrap
```markdown
This is a formula: $$e = mc^2$$
```
This is a formula: $$e = mc^2$$

## Formula Block

Use three ``$`` symbol to wrap

```markdown
This is a formula:
$$$
\begin{matrix}
1 & 2 & 3 \\
4 & 5 & 6 \\
7 & 8 & 9
\end{matrix}\\
$$$
```
This is a formula:
$$$
\begin{matrix}
1 & 2 & 3 \\
4 & 5 & 6 \\
7 & 8 & 9
\end{matrix}\\
$$$

30 changes: 30 additions & 0 deletions static/English/Syntax Tutorials/Media.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Media

## Images

```markdown
<!-- External Image -->
![Test Image](https://fastly.picsum.photos/id/251/200/200.jpg?hmac=_yKttpPQLBisFkKPMRolKUyfZ89QQpENncPdrg8a1J0)
<!-- Internal Image -->
![Test Image](.resources/test-image.jpg)
```
![Test Image](https://fastly.picsum.photos/id/251/200/200.jpg?hmac=_yKttpPQLBisFkKPMRolKUyfZ89QQpENncPdrg8a1J0)
![Test Image](.resources/test-image.jpg)

##PS: To use internal media files, it is required to create a directory with any name starting with the ``.`` symbol in the same directory as the blog file, and store the media files in it. Same for belows.##

## Videos

```markdown
?[Example Video](https://www.w3schools.com/html/movie.mp4)
```
?[Example Video](https://www.w3schools.com/html/movie.mp4)

## Audios

```markdown
:[Example Audio](http://downsc.chinaz.net/Files/DownLoad/sound1/201906/11582.mp3)
```
:[Example Audio](http://downsc.chinaz.net/Files/DownLoad/sound1/201906/11582.mp3)


13 changes: 13 additions & 0 deletions static/English/Syntax Tutorials/Tables.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Tables

Separate the table cells with ``|`` symbol.

```markdown
| Table | Header | Header |
| Row 1 | Some content | Some content |
| Row 2 | Some content | Some content |
```
| Table | Header | Header |
| Row 1 | Some content | Some content |
| Row 2 | Some content | Some content |

3 changes: 1 addition & 2 deletions static/中文/语法教程/独立页面嵌入.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# 独立页面嵌入

你可以链接其它网页文件的链接实现嵌入独立网页

你可以链接其它网页文件的链接实现嵌入独立网页:
```markdown
@[站外链接测试](https://www.w3.org/)
@[站内链接测试](.资源文件/测试.html)
Expand Down

0 comments on commit c985773

Please sign in to comment.