Docs

Static Site Generator¶

The documentation is setup 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

pnpm runDocs

and then open http://localhost:8000

Prod Build¶

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