https://github.com/hq20/soldoc

A solidity documentation generator, based in NatSpec format. :page_with_curl: with standalone HTML, pdf, gitbook and docsify output :pencil2: just plug and play.
https://github.com/hq20/soldoc

doc docgen docsify document documentation documentation-tool gitbook html pdf pdf-generation smart-contracts soldoc solidity solidity-contracts solidity-documentation

Last synced: 24 days ago
JSON representation

A solidity documentation generator, based in NatSpec format. :page_with_curl: with standalone HTML, pdf, gitbook and docsify output :pencil2: just plug and play.

• Host: GitHub
• URL: https://github.com/hq20/soldoc
• Owner: HQ20
• License: gpl-3.0
• Created: 2019-03-08T23:30:10.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T01:51:03.000Z (almost 2 years ago)
• Last Synced: 2024-10-16T07:32:35.947Z (2 months ago)
• Topics: doc, docgen, docsify, document, documentation, documentation-tool, gitbook, html, pdf, pdf-generation, smart-contracts, soldoc, solidity, solidity-contracts, solidity-documentation
• Language: JavaScript
• Homepage: https://soldoc-demo.netlify.com/
• Size: 4.27 MB
• Stars: 64
• Watchers: 5
• Forks: 9
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

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](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.