github-actions 85822663f2 Update docs 2 年之前
..
modules 85822663f2 Update docs 2 年之前
templates dbe796d542 Update docs 2 年之前
README.md dbe796d542 Update docs 2 年之前
antora.yml dbe796d542 Update docs 2 年之前
config.js dbe796d542 Update docs 2 年之前

README.md

Documentation is hosted at https://docs.openzeppelin.com/contracts.

All of the content for the site is in this repository. The guides are in the docs directory, and the API Reference is extracted from comments in the source code. If you want to help improve the content, this is the repository you should be contributing to.

solidity-docgen is the program that extracts the API Reference from source code.

The docs.openzeppelin.com repository hosts the configuration for the entire site, which includes documentation for all of the OpenZeppelin projects.

To run the docs locally you should run npm run docs:watch on this repository.