https://github.com/tiryoh/docker-mkdocs-builder
🐳 Dockerfiles to build MkDocs document project
https://github.com/tiryoh/docker-mkdocs-builder
docker mkdocs
Last synced: 12 months ago
JSON representation
🐳 Dockerfiles to build MkDocs document project
- Host: GitHub
- URL: https://github.com/tiryoh/docker-mkdocs-builder
- Owner: Tiryoh
- License: mit
- Created: 2020-12-21T15:03:09.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-12T18:01:43.000Z (about 1 year ago)
- Last Synced: 2025-05-12T18:45:35.248Z (about 1 year ago)
- Topics: docker, mkdocs
- Language: Dockerfile
- Homepage:
- Size: 307 KB
- Stars: 1
- Watchers: 2
- Forks: 3
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
```
2. Access http://127.0.0.1:8000 to access the content
## Related Projects
* [Tiryoh/actions-mkdocs](https://github.com/Tiryoh/actions-mkdocs)
* GitHub Actions for MkDocs
## (Advanced) Build Docker Image
To build the docker image locally, run the following command.
```sh
# 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](./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](./THIRD-PARTY-NOTICES.md).