npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

kaaper

v0.1.0

Published

Documentation Generator for Starknet

Downloads

2

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

cryptolynxcryptolynx

Keywords

Readme

⚠️ 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?