Add mkdocs.yml instuctions

This commit is contained in:
Zois Pagoulatos 2019-06-04 09:26:03 +02:00
parent 3037d54421
commit c2017d11f0
No known key found for this signature in database
GPG Key ID: A40759B6C8AC2811
2 changed files with 25 additions and 1 deletions

View File

@ -28,7 +28,7 @@ $ docker run --cap-add=NET_ADMIN -d \
``` ```
## Documentation ## Documentation
The full documentation is available at https://containrrr.github.io/watchtower. The full documentation is available at http://haugene.github.io/docker-transmission-openvpn/.
## Please help out (about:maintenance) ## Please help out (about:maintenance)
This image was created for my own use, but sharing is caring, so it had to be open source. This image was created for my own use, but sharing is caring, so it had to be open source.

24
mkdocs.yml Normal file
View File

@ -0,0 +1,24 @@
site_name: docker-transmission-openvpn
site_url: http://haugene.github.io/docker-transmission-openvpn/
repo_url: https://github.com/haugene/docker-transmission-openvpn/
theme:
name: 'material'
markdown_extensions:
- toc:
permalink: True
separator: "_"
nav:
- 'Home': 'index.md'
- 'Run from Docker registry': 'run-from-docker-registry.md'
- 'Supported providers': 'supported-providers.md'
- 'Arguments': 'arguments.md'
- 'Custom pre/post scripts': 'custom-scripts.md'
- 'RSS plugin': 'rss-plugin.md'
- 'Use docker env file': 'dockerenv.md'
- 'Access': 'access.md'
- 'Running on ARM': 'run-on-arm.md'
- 'Synology NAS': 'synology-nas.md'
- 'Systemd integration': 'systemd-integration.md'
- 'Known issues, tips and tricks': 'known-issues.md'
plugins:
- search