Note

This project does not yet exist. The README below is speculative, stay tuned!

mkdocs, but very fast and small

---

picodocs is a simple, fast and small static site generator for documentation written in Markdown.

I love how documentation with MkDocs is a very non-intrusive thing to add to your existing codebase: just a docs/ directory for the markdown content for configuration

picodocs takes great inspiration from projects such as zola, MkDocs and mdBook, though it has a few key differences:

• Like zola and mdBook, picodocs written in Rust, which makes it very fast and small. It is also shipped as a single binary, so you can easily run it on any platform without worrying about dependencies.

• Unlike mdBook, a rendered picodocs site rendered site not split into numbered chapters, like a book. It is more similar to MkDocs, where the documentation is split into pages, which can be linked to each other.

Installation

From prebuilt binaries

For each version, prebuilt binaries are automatically built for Linux, MacOS and Windows.

• You can download and unpack the latest release from the releases page.

• Using cargo-binstall

  cargo binstall picodocs

From source

• cargo install picodocs

• git clone https://github.com/sermuns/picodocs
  cd picodocs
  cargo install