Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

soldoc

Package Overview
Dependencies
Maintainers
2
Versions
20
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

soldoc

An solidity documentation generator, based in NatSpec format.

  • 0.1.3-beta.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
5
decreased by-77.27%
Maintainers
2
Weekly downloads
 
Created
Source

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.

Keywords

FAQs

Package last updated on 05 Feb 2020

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc