https://github.com/tzapu/solidity-docgen-template
a template for solidity-docgen
https://github.com/tzapu/solidity-docgen-template
Last synced: about 1 month ago
JSON representation
a template for solidity-docgen
- Host: GitHub
- URL: https://github.com/tzapu/solidity-docgen-template
- Owner: tzapu
- License: mit
- Created: 2021-06-30T09:19:11.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-01T23:28:05.000Z (almost 4 years ago)
- Last Synced: 2025-04-01T07:25:47.904Z (2 months ago)
- Language: Handlebars
- Size: 4.88 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# solidity-docgen-template
A template for [solidity-docgen](https://github.com/OpenZeppelin/solidity-docgen)
To add this template as a submodule execute the following commands:
```bash
git submodule add [email protected]:tzapu/solidity-docgen-template.git docs/templates
npm i -D doctoc@git+ssh://[email protected]:thlorenz/doctoc.git#master
npm i -D solidity-docgen
```
Add `docs` to your `package.json` scripts as pictured
```
"scripts": {
"docs": "solidity-docgen --solc-module solc-0.8.6 -t docs/templates && doctoc ./docs/ --maxlevel 3",
},
```
Run the docs generating script
```bash
yarn docs
```