soldoc

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 an HTML self hosted 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 pure 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.

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.

License

GPL-3.0