https://github.com/saurfang/solidity-treemap-docs
https://github.com/saurfang/solidity-treemap-docs
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/saurfang/solidity-treemap-docs
- Owner: saurfang
- Created: 2018-06-03T01:52:45.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-06-03T01:54:20.000Z (about 7 years ago)
- Last Synced: 2025-01-30T01:41:26.290Z (4 months ago)
- Language: JavaScript
- Size: 183 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
OpenZeppelin Documentation Generator
====================================
Generates OpenZeppelin API docs at https://openzeppelin.org/api/docs/.
## Generating Docs
To generate documentation from scratch, run:
```sh
npm run gen-docs
```
After modifying styles, header links, footer, and static documents, you can automatically generate all OpenZeppelin API docs - one per contract in the codebase - by running:
```sh
npm run bump-docs --
```
For example:
```sh
npm run bump-docs -- v1.7.0
```
This command will automatically:
* Run [solidity-docgen](https://github.com/spalladino/solidity-docgen) on the OpenZeppelin codebase at the given tag.
* Generate a new Docusaurus version matching the OpenZeppelin release tag.
* Build the Docusaurus project, yielding the result in `docs/website/build`.