https://github.com/nwesterhausen/docker-nginx-mkdocs-material

Pulls raw mkdocs, builds, then serves with nginx
https://github.com/nwesterhausen/docker-nginx-mkdocs-material

Last synced: 6 days ago
JSON representation

Pulls raw mkdocs, builds, then serves with nginx

• Host: GitHub
• URL: https://github.com/nwesterhausen/docker-nginx-mkdocs-material
• Owner: nwesterhausen
• License: mit
• Created: 2018-12-21T16:57:42.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T08:20:19.000Z (about 1 year ago)
• Last Synced: 2024-12-29T02:34:59.543Z (8 days ago)
• Language: Dockerfile
• Homepage:
• Size: 30.3 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# docker-nginx-mkdocs-material

Pulls raw mkdocs, builds, then serves with nginx

## Usage

Set up a git repository that can be cloned. This will house your mkdocs raw markdown and configuration ([Github hosted example](https://github.com/nwesterhausen/public-wiki)).

This container uses the default nxinx:alpine as a base, so the final documentation site is run on port 80 in the container.

To run the container exposing the mkdocs site on localhost:8900:

```

docker run \

  --env "DOC_REPO=github.com/nwesterhausen/docker-nginx-mkdocs-material" \

  --publish 172.0.0.1:8900:80 \

  nwesterhausen/static-mkdocs-material

```

### Private repositories

To use with a private repository, set the ACCESS_TOKEN variable with a personal access token that has private repo access.

## Environment Variables

| Name         | Usage                                                                                                                            |

| ------------ | -------------------------------------------------------------------------------------------------------------------------------- |

| DOC_REPO     | Web URL for repository. 'https://' will be prepended to this value                                                               |

| ACCESS_TOKEN | For private repository, include a personal access token which gets inserted before DOC_REPO like 'https://ACCESS_TOKEN@DOC_REPO' |