https://github.com/ripple/dactyl
Tools to make enterprise documentation from Markdown sources.
https://github.com/ripple/dactyl
dactyl documentation markdown pdf-generation
Last synced: 5 months ago
JSON representation
Tools to make enterprise documentation from Markdown sources.
- Host: GitHub
- URL: https://github.com/ripple/dactyl
- Owner: ripple
- License: mit
- Created: 2017-02-17T21:14:00.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-11-23T18:08:18.000Z (over 2 years ago)
- Last Synced: 2026-01-07T22:51:01.232Z (5 months ago)
- Topics: dactyl, documentation, markdown, pdf-generation
- Language: Python
- Homepage:
- Size: 2.2 MB
- Stars: 70
- Watchers: 18
- Forks: 24
- Open Issues: 31
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dactyl
Documentation tools for enterprise-quality documentation from Markdown source. Dactyl has advanced features to enable [single-sourcing](https://en.wikipedia.org/wiki/Single_source_publishing) and an extensible syntax for building well-organized, visually attractive docs. It generates output in HTML (natively), and can make PDFs if you have [Prince][] installed.
[Prince]: http://www.princexml.com/
## Installation
Dactyl requires [Python 3](https://python.org/). Install with [pip](https://pip.pypa.io/en/stable/):
```
sudo pip3 install dactyl
```
Or a local install in a virtualenv:
```sh
# Create an activate a virtualenv so the package and dependencies are localized
virtualenv -p `which python3` venv_dactyl
source venv_dactyl/bin/activate
pip3 install dactyl
```
## Documentation
Dactyl's documentation is built from this repository's [examples/](examples/) section. You can see the finished version at:
>