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

@jplsaez/solidoc

v1.2.0

Published

Solidity Documentation Generator

Downloads

35

Readme

Solidoc: Documentation Generator for Solidity

This command-line utility creates markdown-based documentation for your Solidity project(s)

Getting Started

npm install @jplsaez/solidoc --save-dev
yarn add --dev @jplsaez/solidoc

How to Use Solidoc?

Create solidoc.json configuration file in your project root with the following properties:

  • pathToRoot: root path to find the "contracts" directory with the smart contracts souce code.
  • outputPath: path to store the generated documentation.
  • includedContracts: comma separated list of smart contracts to generate documentation.
{
  "pathToRoot": "./",  
  "outputPath": "./docs",
  "includedContracts": "ContractName1, ContractName2"	
}

Compile your contracts with Truffle. That way compiled json files will be created including AST sections (abstract syntax tree) used by solidoc to generate documentation. Note that @author NatSpec tag should not be used in the smart contracts source code to prevent errors in the generated AST sections.

Finally call solidoc:

npx solidoc
yarn solidoc

This will generate documentation to the outputPath directory.

Overrides

If you wish to change bits and pieces of the documentation generated, edit solidoc templates on the following directory:

solidoc/templates/