Kaaper

Documentation generator for Cairo projects.

⚠️ WARNING! ⚠️

This repo contains highly experimental code. Expect rapid iteration.

🎟️ Description

Kaaper is a tool to generate documentation for Cairo projects.

🎗️ Prerequisites

Node JS, preferably 16.xx
Yarn

📦 Installation

yarn
yarn install

🔬 Usage

Install CLI Locally

npm run create
npm run local

To see available commands

kaaper

Generate docs

kaaper generate <rootdir> <outdir>

Generate docs (comment only)

kaaper generate --comment <rootdir> <outdir>

Check comment compliancy

kaaper check-compliance <rootdir>

🌡️ Testing

yarn test

🫶 Contributing

📄 License

kaaper is released under the MIT.

❓ Reference

Kaaper, also commonly known as Sheikh el-Beled, was an ancient Egyptian scribe and priest who lived between the late 4th Dynasty and the early 5th Dynasty (around 2500 BCE).

The job of a scribe was to record in writing the everyday life and extraordinary happenings in ancient Egypt.

A documentation generator has pretty much the same duties as a scribe, right?