⚠️ WARNING! ⚠️
This repo contains highly experimental code. Expect rapid iteration.
Kaaper is a tool to generate documentation for Cairo projects.
Node JS, preferably 16.xx
Yarn
yarn
yarn install
Install CLI Locally
npm run create
npm run local
To see available commands
kaaper
kaaper generate <rootdir> <outdir>
Generate docs (comment only)
kaaper generate --comment <rootdir> <outdir>
kaaper check-compliance <rootdir>
yarn test
kaaper is released under the MIT.
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?
FAQs
Documentation Generator for Starknet
We found that kaaper demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket’s new Tier 1 Reachability filters out up to 80% of irrelevant CVEs, so security teams can focus on the vulnerabilities that matter.
Research
/Security News
Ongoing npm supply chain attack spreads to DuckDB: multiple packages compromised with the same wallet-drainer malware.
Security News
The MCP Steering Committee has launched the official MCP Registry in preview, a central hub for discovering and publishing MCP servers.