1
0
mirror of https://github.com/containrrr/watchtower.git synced 2024-12-03 08:45:43 +02:00
watchtower/mkdocs.yml
Zois Pagoulatos 60a6300f0e
Set different default branch for mkdocs edit (#846)
From mkdocs [documentation](https://www.mkdocs.org/user-guide/configuration/#edit_uri):

```
Note

On a few known hosts (specifically GitHub, Bitbucket and GitLab), the edit_uri is derived from the 'repo_url' and does not need to be set manually. Simply defining a repo_url will automatically populate the edit_uri configs setting.

For example, for a GitHub- or GitLab-hosted repository, the edit_uri would be automatically set as edit/master/docs/ (Note the edit path and master branch).

For a Bitbucket-hosted repository, the equivalent edit_uri would be automatically set as src/default/docs/ (note the src path and default branch).

To use a different URI than the default (for example a different branch), simply set the edit_uri to your desired string. If you do not want any "edit URL link" displayed on your pages, then set edit_uri to an empty string to disable the automatic setting.
```
2021-03-09 14:18:03 +01:00

35 lines
1.0 KiB
YAML

site_name: Watchtower
site_url: http://containrrr.github.io/watchtower/
repo_url: https://github.com/containrrr/watchtower/
edit_uri: edit/main/docs/index.md
theme:
name: 'material'
palette:
scheme: containrrr
logo: images/logo-450px.png
favicon: images/favicon.ico
extra_css:
- stylesheets/theme.css
markdown_extensions:
- toc:
permalink: True
separator: "_"
- codehilite
nav:
- 'Home': 'index.md'
- 'Introduction': 'introduction.md'
- 'Usage overview': 'usage-overview.md'
- 'Arguments': 'arguments.md'
- 'Notifications': 'notifications.md'
- 'Container selection': 'container-selection.md'
- 'Private registries': 'private-registries.md'
- 'Linked containers': 'linked-containers.md'
- 'Remote hosts': 'remote-hosts.md'
- 'Secure connections': 'secure-connections.md'
- 'Stop signals': 'stop-signals.md'
- 'Lifecycle hooks': 'lifecycle-hooks.md'
- 'Running multiple instances': 'running-multiple-instances.md'
- 'Metrics': 'metrics.md'
plugins:
- search