diff --git a/README.md b/README.md index 5185aa0d3..327e1de62 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ $ docker run --cap-add=NET_ADMIN -d \ ``` ## 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) This image was created for my own use, but sharing is caring, so it had to be open source. diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..851df66b2 --- /dev/null +++ b/mkdocs.yml @@ -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 \ No newline at end of file