> 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](https://soldoc-demo.netlify.com/). 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 ```bash # 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 ```ts 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](LICENSE) ## Credits Credits to all external open/free material used. Thank you all. The [sun](https://www.iconfinder.com/icons/2995005/giallo_sole_soleggiato_sun_sunny_weather_yellow_icon), the [A Directory Tree List Style A PEN BY Alex Raven](https://codepen.io/asraven/pen/qbrQMX), the [Font Family](https://www.dafont.com/pt/subscriber.font). As well as [Connor](https://github.com/connorltodd), who drafted the initial HTML template, and [zlocate](https://github.com/zlocate) Thank you. Danke. Merci. Grazie. Gracias. Arigato. Obrigado.

soldoc

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Sick of boring JavaScript newsletters?

Downloads in past