https://github.com/05bit/docta
A new healing docs kit
https://github.com/05bit/docta
Last synced: 5 months ago
JSON representation
A new healing docs kit
- Host: GitHub
- URL: https://github.com/05bit/docta
- Owner: 05bit
- License: bsd-3-clause
- Created: 2014-04-09T07:35:14.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2019-05-11T14:23:55.000Z (about 7 years ago)
- Last Synced: 2025-10-27T08:33:28.443Z (8 months ago)
- Language: HTML
- Homepage: http://docta.05bit.com
- Size: 275 KB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[**Docta**](http://docta.05bit.com) is a new healing docs kit.
==============================================================
Technically speaking, it's a **static-site generator** slightly focused on **building documetation**.
Project homepage: http://docta.05bit.com
Current version: **0.2.4a** from 2015 Aug 14 powered by Mistune or **0.2.3** running Misaka.
Install
-------
Easiest way to install is via pip:
```bash
$ pip install docta
```
Quickstart
----------
Setup a new project:
```bash
$ mkdir docs
$ cd docs
$ docta init
```
That's it! Project is ready for building!
```bash
$ docta build
$ docta serve --watch
```
After running `build` and `serve` commands you should see something like:
```bash
Serving directory: /home/user/docs/_html
Running at http://127.0.0.1:8000
23 April 2014 - 02:14:36
```
Thats it! You may edit or create **.md** files, starting from **index.md** with your favorite text editor.
License
-------
Docta is distributed for free and its source code is licensed under the [BSD 3-Clause License](https://github.com/05bit/python-docta/blob/master/LICENSE).