Documentation

Static Site Generator¶

The documentation is set up with MkDocs and Material for MkDocs.

Usage¶

Configuration¶

The configuration is in the mkdocs.yml file.
The pages and images are stored in the docs folder.

Local Setup¶

To run the docs locally, you can use Docker.
To build the Docker image, run:

docker build . -t mkdocs

To run the container:

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

or

npm run runDocs

and then open http://localhost:8000.

Prod Build¶

The Documentation is hosted on GitHub Pages and is rebuilt on every push to the main branch using the GitHub Action pushDocs.yml and forcefully pushed to the gh-deploy branch.
The current URL is: https://docs.spreadsheet-importer.com/