tiryoh/mkdocs-builder repository overview

⁠docker-mkdocs-builder

Dockerfile that just builds the MkDocs document

⁠Usage

1. Run the following command in your mkdocs project to start the local server

docker run --rm -p 8000:8000 -v ${PWD}:/docs tiryoh/mkdocs-builder:alpine

1. Access http://127.0.0.1:8000⁠ to access the content

⁠Related Projects

• Tiryoh/actions-mkdocs⁠
  • GitHub Actions for MkDocs

⁠(Advanced) Build Docker Image

To build the docker image locally, run the following command.

# Debian
docker build -t tiryoh/mkdocs-builder:debian -f debian/Dockerfile .

# Alpine
docker build -t tiryoh/mkdocs-builder:alpine -f alpine/Dockerfile .

⁠License

Copyright (c) 2020-2023 Daisuke Sato

This repository is licensed under the MIT License, see LICENSE⁠. Unless attributed otherwise, everything in this repository is licensed under the MIT license.

⁠Acknowledgements

This repository includes third-party libraries and software. See THIRD-PARTY-NOTICES.md⁠.