soldoc

A solidity documentation generator, based in NatSpec format. 📃 with standalone HTML, pdf, gitbook and docsify output ✏️ just plug and play.

Showing:

Popularity

Downloads/wk

78

GitHub Stars

31

Maintenance

Last Commit

1yr ago

Contributors

5

Package

Dependencies

2

Size (min+gzip)

140.3KB

License

GPL-3.0-only

Type Definitions

Tree-Shakeable

No?

Categories

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 👀
  • The generated output can be standalone HTML 😁, a PDF file 👔, gitbook format 😱 or docsify format 💥
  • All formats support emojis 🙊
  • Ignore documentation generator for some specific files 😎
  • Really fast 🐇

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.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial