Static Documentation Generator
Project description
QuakerDocs
QuakerDocs is a modern and reliable static documentation generator. It was designed from the ground up to replace older documentation generators. It generates a fully static web page with your documentation, so it can work without a server. Some of the features that QuakerDocs has are:
- Fast generation of a static website
- Write documentation using reStructuredText
- Super-fast live search
- Handy bookmarking system
- Easily configurable
- Only takes one command!
Getting Started with QuakerDocs
QuakerDocs is very easy to use, and you do not need a lot to get started!
Installation
First of all, make sure you have Clang and the LLVM wasm-compiler installed.
For example, on Ubuntu:
apt install clang lld
Then, to install the QuakerDocs application use the following command:
pip install quaker
After running this command all the requirements are installed and you can immediately use the quaker command.
Quickstart
To create an example quickstart project in a directory, you can use the following command:
quaker --init <your_directory_name>
This command creates a directory with some of the necessary files to get
you started such as conf.py
, and index.rst
.
Usage
To use QuakerDocs to turn your RST or Markdown files into static webpages you need the follow these steps:
-
Open the directory containing your
conf.py
in the terminal.cd path/to/my/project/
-
To convert your documentation files into static webpages, run the following command.
quaker .
-
Change into the
build/
directory, and start a webserver.cd build/ python3 -m http.server
-
To visit the generated documentation page visit
localhost:8000
in your web browser.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.