From 1be3493c048e5ca6c6cd2e58b601f88cfeb6499f Mon Sep 17 00:00:00 2001 From: Nicole Rappe Date: Thu, 21 Dec 2023 05:13:06 -0700 Subject: [PATCH] Add Container Documentation/Docker/Docker Compose/Material MkDocs.md --- .../Docker/Docker Compose/Material MkDocs.md | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 Container Documentation/Docker/Docker Compose/Material MkDocs.md diff --git a/Container Documentation/Docker/Docker Compose/Material MkDocs.md b/Container Documentation/Docker/Docker Compose/Material MkDocs.md new file mode 100644 index 0000000..2ddfb81 --- /dev/null +++ b/Container Documentation/Docker/Docker Compose/Material MkDocs.md @@ -0,0 +1,30 @@ +**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/Container%20Documentation/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/Container%20Documentation/Docker/Docker%20Compose/Gitea/) container to host your own code repository! This all assumes you have already deployed Docker and/or [Portainer](https://docs.bunny-lab.io/Container%20Documentation/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 +``` \ No newline at end of file