Metadata-Version: 2.1
Name: thothglyph-doc
Version: 0.2.3
Summary: A Documentation converter and language for Engineers
License: MIT
Author: nakandev
Author-email: nakandev.s@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: cairosvg (>=2.5.2,<3.0.0)
Requires-Dist: markdown-it-py[plugins] (>=3.0.0,<4.0.0)
Requires-Dist: pillow (>=9.2.0,<10.0.0)
Description-Content-Type: text/markdown

# Thothglyph

A Documentation converter and language for Engineers

(Θωθ)

## Requirements

* python >= 3.8
* pillow
* cairosvg

## Installation

Minimum

```sh
pip install thothglyph-doc
```

\+ writers

```
# pdf
sudo apt install texlive-luatex texlive-fonts-recommended texlive-fonts-extra texlive-lang-cjk
# docx
pip install python-docx
```

\+ extensions

```
# graphviz
sudo apt install graphviz
pip install graphviz
# plantuml
sudo apt install plantuml
# blockdiag
pip install blockdiag actdiag seqdiag nwdiag
# mermaid
npm install -g @mermaid-js/mermaid-cli
# wavedrom
pip install wavedrom
```

## Usage

```sh
thothglyph -t html document.tglyph
```

## Languages

See [documents](https://thothglyph-doc.readthedocs.io/en/latest/index.html)

## Tools

* [vim-thothglyph](https://github.com/thothglyph/vim-thothglyph)
* [vscode-thothglyph](https://github.com/thothglyph/vscode-thothglyph)

