This website is built using Docusaurus, a modern static website generator.
- API Specifications - OpenAPI specifications for json-rpc APIs and how to autogenerate documentation
This project uses OpenAPI specifications to generate API documentation. When adding new API specs:
-
First, generate the API documentation:
yarn openapi:generate:all # Generate all API docs # OR for specific namespaces yarn docusaurus gen-api-docs eth # Generate Ethereum API docs yarn docusaurus gen-api-docs zkevm # Generate zkEVM API docs yarn docusaurus gen-api-docs txpool # Generate txpool API docs -
Then start the development server:
yarn start
This ensures all referenced documentation files exist before the server starts.
$ yarn
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
Using SSH:
$ USE_SSH=true yarn deploy
Not using SSH:
$ GIT_USER=<Your GitHub username> yarn deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.