This website is built using Docusaurus 2, a modern static website generator.
Contributing to the docs site is a great way to get involved in the dev community and help other devs along the way! Check out our guidelines here.
Install solidity doc gen
npm install solidity-docgen
Get the correct compiler version
npm install -D solc-0.7@npm:solc@0.7.6
Put the updated template contract.hbs in a /templates folder under the same directory as /contracts that you want to generate
Run npx solidity-docgen --solc-module solc-0.7 -t ./templates
npm install --save-dev typedoc typedoc-plugin-markdown
typedoc --out <docs> src/index.ts
see https://www.npmjs.com/package/typedoc-plugin-markdown for details
create .env file with APPLICATION_ID and the API_KEY (write access)
Edit config.json file with
- start url from updated website
- sitemap url from updated website: ex) for docs: https://docs.pooltogether.com/sitemap.xml
- "v3-docs" index name
- install jq :
brew install jqrundocker run -it --env-file=.env -e "CONFIG=$(cat ./config.json | jq -r tostring)" algolia/docsearch-scraper
Create a markdown file in its respective versioned docs, or versioned SDK, directory.
Relative or absolute paths work. End links with a trailing /
yarn installyarn run startThis command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
yarn docusaurus clearyarn buildThis command generates static content into the build directory and can be served using any static contents hosting service.
GIT_USER=<Your GitHub username> USE_SSH=true yarn deployIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.