ChainAPI Documentation

Getting Started

Pull the docker container for the material theme - it contains all the pre-requisites for mkdocs:

docker pull squidfunk/mkdocs-material

Running Locally

Run the container with this command and the docs will be built and available at localhost:8000. It will also auto-reload as you make changes.

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material

Deployments

The docs site is hosted on Github Pages in this project.

The main workflow builds the site and pushes this to the gh-pages branch. Github then takes over and deploys this, which can be viewed in the auto-created pages-build-deployment workflow.

Hyperlink Checks

The main workflow also checks for any broken hyperlinks using markdown-link-check wrapped in the related action.

To run this locally, use this command:

find . -name \*.md -print0 | xargs -0 -n1 markdown-link-check -c link-check-config.json