Skip to content

Commit

Permalink
docs: markdown docs file.
Browse files Browse the repository at this point in the history
  • Loading branch information
auula committed Jul 3, 2024
1 parent b04fa81 commit 2e4fe4a
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Typikon lets you use markdown to write your online books.

## Introduce

Typikon name derived from [Typikon](https://en.wikipedia.org/wiki/Typikon) Book, the a static website rendering tool similar to mdbook and hugo, but it focuses only on rendering markdown into an online book, and is easier to use than the other tools.
Typikon name derived from [Typikon](https://en.wikipedia.org/wiki/Typikon) Book, the a static website rendering tool similar to mdbook and gitbook, but it focuses only on rendering markdown into an online book, and is easier to use than the other tools.

---

Expand Down
2 changes: 1 addition & 1 deletion book/chinese.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Typikon 让您可以使用 Markdown 编写您的在线书籍。

### 介 绍

Typikon 的名字源自 [Typikon](https://en.wikipedia.org/wiki/Typikon) 书籍,它是一个类似于 mdbook 和 Hugo 的静态网站渲染工具,但它专注于将 Markdown 渲染成在线书籍,比其他工具更易于使用。
Typikon 的名字源自 [Typikon](https://en.wikipedia.org/wiki/Typikon) 书籍,它是一个类似于 mdbook 和 gitbook 的静态网站渲染工具,但它专注于将 Markdown 渲染成在线书籍,比其他工具更易于使用。

---

Expand Down
2 changes: 1 addition & 1 deletion book/english.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Typikon lets you use markdown to write your online books.

### Introduce

Typikon name derived from [Typikon](https://en.wikipedia.org/wiki/Typikon) Book, the a static website rendering tool similar to mdbook and hugo, but it focuses only on rendering markdown into an online book, and is easier to use than the other tools.
Typikon name derived from [Typikon](https://en.wikipedia.org/wiki/Typikon) Book, the a static website rendering tool similar to mdbook and gitbook, but it focuses only on rendering markdown into an online book, and is easier to use than the other tools.

---

Expand Down
2 changes: 1 addition & 1 deletion book/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Typikon lets you use markdown to write your online books.

### Introduce

Typikon name derived from [Typikon](https://en.wikipedia.org/wiki/Typikon) Book, the a static website rendering tool similar to mdbook and hugo, but it focuses only on rendering markdown into an online book, and is easier to use than the other tools.
Typikon name derived from [Typikon](https://en.wikipedia.org/wiki/Typikon) Book, the a static website rendering tool similar to mdbook and gitbook, but it focuses only on rendering markdown into an online book, and is easier to use than the other tools.

---

Expand Down
2 changes: 1 addition & 1 deletion book/introduce-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Typikon 让您可以使用 Markdown 编写您的在线书籍。

### 介 绍

Typikon 的名字源自 [Typikon](https://en.wikipedia.org/wiki/Typikon) 书籍,它是一个类似于 mdbook 和 Hugo 的静态网站渲染工具,但它专注于将 Markdown 渲染成在线书籍,比其他工具更易于使用。
Typikon 的名字源自 [Typikon](https://en.wikipedia.org/wiki/Typikon) 书籍,它是一个类似于 mdbook 和 gitbook 的静态网站渲染工具,但它专注于将 Markdown 渲染成在线书籍,比其他工具更易于使用。

---

Expand Down
2 changes: 1 addition & 1 deletion book/introduce.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Typikon lets you use markdown to write your online books.

### Introduce

Typikon name derived from [Typikon](https://en.wikipedia.org/wiki/Typikon) Book, the a static website rendering tool similar to mdbook and hugo, but it focuses only on rendering markdown into an online book, and is easier to use than the other tools.
Typikon name derived from [Typikon](https://en.wikipedia.org/wiki/Typikon) Book, the a static website rendering tool similar to mdbook and gitbook, but it focuses only on rendering markdown into an online book, and is easier to use than the other tools.

---

Expand Down
4 changes: 2 additions & 2 deletions book/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Remember to refresh the environment variables to ensure that Typikon can be used

## Getting Started

Typikon provides three main commands: init to initialize the working directory, build to generate static HTML files, and help to provide command-specific help information. When you run the typikon main program, it will display the following:
Typikon provides three main commands: `init` to initialize the working directory, `build` to generate static HTML files, and `help` to provide command-specific help information. When you run the typikon main program, it will display the following:

```shell
$: typikon
Expand Down Expand Up @@ -54,7 +54,7 @@ Before you start writing your book content, you need a clean directory to serve
$: mkdir example && cd example && typikon init
```

After initialization, the default working directory is example. Inside example, you will find several key subdirectories and files, but the most important are settings.yml and root.yml. In root.yml, you map your Markdown files to chapters in your book directory. For example:
After initialization, the default working directory is example. Inside example, you will find several key subdirectories and files, but the most important are `settings.yml` and `root.yml`. In `root.yml`, you map your Markdown files to chapters in your book directory. For example:


```yaml
Expand Down

0 comments on commit 2e4fe4a

Please sign in to comment.