-
Notifications
You must be signed in to change notification settings - Fork 9
/
README.md
52 lines (28 loc) · 2.07 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# Typikon
Typikon lets you use markdown to write your online books.
---
[](https://codecov.io/github/auula/typikon)
[](https://github.com/auula/typikon/blob/master/LICENSE)
[](https://github.com/auula/typikon/actions/workflows/rust.yml)
[](https://github.com/auula/typikon/releases)
<!-- [](https://twitter.com/auula_) -->
---
## Introduce
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.
---
## Preview
<div style="display: flex; justify-content: space-around;">
<img src="https://img.ibyte.me/z1zano.png" alt="Alt text" style="width: 400px; height: 300px;">
<img src="https://img.ibyte.me/lvc0iv.png" alt="Alt text" style="width: 400px; height: 300px;">
</div>
---
## Document
To learn how to use the `Typikon` program, you can refer to the documentation that I have written. This documentation is generally rendered and built using Typikon. The online documentation can be accessed at the following address: [https://typikonbook.github.io](https://typikonbook.github.io) 🌟.
---
## Stargazers over time
[](https://starchart.cc/auula/typikon)
---
## Contributors
This project follows the all-contributors specification. All kinds of contributions are welcome. Thanks to all the contributors below! 🤝
