https://github.com/iwillspeak/docket
Simple Markdown to HTML documentation rendering
https://github.com/iwillspeak/docket
markdown rust static-site-generator
Last synced: over 1 year ago
JSON representation
Simple Markdown to HTML documentation rendering
- Host: GitHub
- URL: https://github.com/iwillspeak/docket
- Owner: iwillspeak
- License: apache-2.0
- Created: 2017-11-05T11:06:32.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-06-25T14:26:09.000Z (about 3 years ago)
- Last Synced: 2025-04-10T00:04:38.119Z (over 1 year ago)
- Topics: markdown, rust, static-site-generator
- Language: Rust
- Homepage: http://willspeak.me/docket/
- Size: 506 KB
- Stars: 23
- Watchers: 1
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Docket
[![Build Status][build_badge_image]][build_info] [![Build Docker Container][docker_badge_image]][docker_info]
Simple markdown to HTML documentation rendering. Docket aims to be a Rust clone of [`d`](https://github.com/sjl/d).
## Key Features
* Binary which can be installed with `cargo install`
* Command line argument parsing with [Docopt](https://docs.rs/docopt/0.8.1/docopt/)
* Markdown rendering with `pulldown-cmark`.
* Syntax highlighting with [Syntect](https://github.com/trishume/syntect/).
* Javascript powered search.
* Zero-configuration.
## Installation
Docket can be installed with cargo via `cargo install docket`. Once installed you should be able to run it form the command line as `docket`.
Docket has two Cargo features which are enabled by default. You can disable them with `--no-default-features` when installing if you don't need them to save some time.
* `watch` - Support for watching files and re-generating the output folder when changes are made.
* `par_render` - Support for rendering pages in parallel using the Rayon crate.
## Getting Started
To begin creating your documentation create a new `docs/` folder at the root of your repository. Add a file called `index.md` with a short markdown description of the project. Add pages by creating new markdown files in the `docs/` folder. Each page should have a level-1 heading at the beginning which is treated as the title of the page.
To render the HTML output change to the `docs/` folder and run `docket`. This should create a new `docs/build/` folder containing the rendered site; ready to be published to a web-server or served with GitHub Pages. For more information about setup and configuration [check out the docs](https://iwillspeak.github.io/docket/).
[build_badge_image]: https://dev.azure.com/iwillspeak/GitHub/_apis/build/status/iwillspeak.docket?branchName=main
[build_info]: https://dev.azure.com/iwillspeak/GitHub/_build/latest?definitionId=1&branchName=main
[docker_badge_image]: https://github.com/iwillspeak/docket/actions/workflows/container.yml/badge.svg
[docker_info]: https://github.com/iwillspeak/docket/actions/workflows/container.yml