30 lines
1.4 KiB
Markdown
30 lines
1.4 KiB
Markdown
**Purpose**: Documentation that simply works. Write your documentation in Markdown and create a professional static site for your Open Source or commercial project in minutes – searchable, customizable, more than 60 languages, for all devices.
|
||
|
||
!!! note
|
||
This is best deployed in tandem with the [Git Repo Updater](https://docs.bunny-lab.io/Containers/Docker/Docker%20Compose/Custom%20Containers/Git%20Repo%20Updater/) container in its own stack. Utilizing this will allow you to push commits to a repository to immediately (within 5 seconds) push changes into MKDocs without needing SSH/Portainer access to the server hosting MKDocs. If you don't have a GitHub account, consider deploying a [Gitea](https://docs.bunny-lab.io/Containers/Docker/Docker%20Compose/Gitea/) container to host your own code repository! This all assumes you have already deployed [Docker and Portainer](https://docs.bunny-lab.io/Containers/Portainer/Deploy%20Portainer/).
|
||
|
||
```jsx title="docker-compose.yml"
|
||
version: '3'
|
||
|
||
services:
|
||
mkdocs:
|
||
container_name: mkdocs
|
||
image: squidfunk/mkdocs-material
|
||
restart: always
|
||
environment:
|
||
- TZ=America/Denver
|
||
ports:
|
||
- "8000:8000"
|
||
volumes:
|
||
- /srv/containers/material-mkdocs/docs:/docs
|
||
networks:
|
||
docker_network:
|
||
ipv4_address: 192.168.5.76
|
||
networks:
|
||
docker_network:
|
||
external: true
|
||
```
|
||
|
||
```jsx title=".env"
|
||
N/A
|
||
``` |