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

soldoc

v0.1.3-beta.2

Published

An solidity documentation generator, based in NatSpec format.

Downloads

41

Readme

soldoc is a solidity documentation generator. This generator was created due to a need of giving documentation to developers and clients. Thinking about it, we first created this tool to generate a standalone HTML page, but then we also decided to generate a PDF.

See demo here.

Please note that, there's also a pdf example in ./example folder. This pdf is a first draft. We intend to have a better template and open the opportunity to get new templates.

Features

  • Generates documentation with soft colors :eyes:
  • The generated output can be standalone HTML :grin:, a PDF file :necktie:, gitbook format :scream: or docsify format :boom:
  • All formats support emojis :speak_no_evil:
  • Ignore documentation generator for some specific files :sunglasses:
  • Really fast :rabbit2:

Installation and Usage

# Go to your project folder.
cd project-folder/

# Install soldoc.
npm install --save-dev soldoc

# Install soldoc's peerDependencies (in case you don't have them yet).
npm install --save-dev directory-tree highlight.js markdown-it markdown-it-emoji meow mustache node-emoji pdf-from-html

# Run soldoc.
npx soldoc docs/ Sample.sol

# View documentation
open ./docs/Sample.html

soldoc supports many output formats, being pure HTML the default one.

Use soldoc --help to get more information about output formats and other options.

Use internally

Your can also use soldoc within your project

import { generate } from 'soldoc';

generate(outputType: string, ignoreFilesList: string[], outputFolder: string, inputPath: string)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

GPL-3.0

Credits

Credits to all external open/free material used.

Thank you all.

The sun, the A Directory Tree List Style A PEN BY Alex Raven, the Font Family. As well as Connor, who drafted the initial HTML template, and zlocate

Thank you. Danke. Merci. Grazie. Gracias. Arigato. Obrigado.