https://github.com/auula/typikon

Typikon lets you use markdown to write your online books.
https://github.com/auula/typikon

book books bootstrap5 dcos docs full-text-search html hugo js markdown markdown-to-html mdbook mkdocs online rust rust-lang

Last synced: 2 days ago
JSON representation

Typikon lets you use markdown to write your online books.

• Host: GitHub
• URL: https://github.com/auula/typikon
• Owner: auula
• License: apache-2.0
• Created: 2024-06-24T15:00:46.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-09-19T12:08:51.000Z (4 months ago)
• Last Synced: 2025-01-13T06:03:39.300Z (9 days ago)
• Topics: book, books, bootstrap5, dcos, docs, full-text-search, html, hugo, js, markdown, markdown-to-html, mdbook, mkdocs, online, rust, rust-lang
• Language: Rust
• Homepage: https://typikonbook.github.io
• Size: 17.4 MB
• Stars: 290
• Watchers: 2
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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)

---

## 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



    

    



---

## 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)