https://github.com/crazy-max/docker-docs-new
https://github.com/crazy-max/docker-docs-new
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/crazy-max/docker-docs-new
- Owner: crazy-max
- Created: 2021-09-11T00:35:17.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-03-10T02:30:32.000Z (over 4 years ago)
- Last Synced: 2025-10-30T08:50:51.519Z (9 months ago)
- Language: HTML
- Homepage: https://crazymax.dev/docker-docs/
- Size: 7.49 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Docker docs
## About
Sample repository for [Docker documentation](https://docs.docker.com/) to
try out [Mkdocs Material](https://github.com/squidfunk/mkdocs-material/).
Live at https://docker.github.io/hack-embedded-docs-extension/
## Usage
```shell
# Build docs image and output to ./site
docker buildx bake
# Run docs image and watch for changes with compose
docker-compose up
# or with docker run
docker buildx bake base
docker run --rm -it -p 8000:8000 -v $(pwd):/docs docs:local
# Open http://localhost:8000 in your browser
# Publish docker extension
docker buildx bake ddext --set *.tags=docker/embedded-docs-extension:0.1.0 --push
```
## Resources
* https://docker.github.io/hack-embedded-docs-extension/macros/
* https://www.mkdocs.org/
* https://squidfunk.github.io/mkdocs-material/getting-started/
* https://facelessuser.github.io/pymdown-extensions/
* https://mkdocs-macros-plugin.readthedocs.io/en/latest/
* https://jinja.palletsprojects.com/en/3.0.x/templates/