# typikon

**Repository Path**: statx/typikon

## Basic Information

- **Project Name**: typikon
- **Description**: https://github.com/auula/typikon.git
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-21
- **Last Updated**: 2025-07-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Typikon

Typikon lets you use markdown to write your online books.

---

![https://img.shields.io/badge/Typikon-Rust%20CLI-brightgreen](https://img.shields.io/badge/📖%20Typikon-Rust%20🦀️-yellow)
[![codecov](https://codecov.io/github/auula/typikon/branch/main/graph/badge.svg?token=FaR2OdNYeB)](https://codecov.io/github/auula/typikon)
[![License](https://img.shields.io/github/license/auula/typikon.svg)](https://github.com/auula/typikon/blob/master/LICENSE)
[![action](https://github.com/auula/typikon/actions/workflows/rust.yml/badge.svg?event=push)](https://github.com/auula/typikon/actions/workflows/rust.yml)
[![release](https://img.shields.io/github/release/auula/typikon.svg)](https://github.com/auula/typikon/releases)
<!-- [![Twitter URL](https://img.shields.io/twitter/follow/auula_?style=social)](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

[![Stargazers over time](https://starchart.cc/auula/typikon.svg?variant=adaptive)](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! 🤝


![Contributors](https://contributors-img.web.app/image?repo=auula/typikon)


---

## WeChat Group

> 中国大陆用户可以加微信群一起讨论设计与代码实现细节。

<img src="https://img.ibyte.me/nlbxzp.jpg" alt="Alt text" style="width: 180px; height: 260px;">