hedgedoc/docs/mkdocs.yml

94 lines
3 KiB
YAML
Raw Normal View History

site_name: HedgeDoc
site_url: https://docs.hedgedoc.org
repo_url: https://github.com/hedgedoc/hedgedoc
site_description: 'HedgeDoc Documentation'
site_author: 'HedgeDoc Developers'
docs_dir: content
edit_uri: https://github.com/hedgedoc/hedgedoc/edit/master/docs/content/
nav:
- Home: index.md
- Installation:
- 'Getting Started': setup/getting-started.md
- Official installation methods:
- 'Docker Image': setup/docker.md
- 'Manual Installation': setup/manual-setup.md
- Heroku: setup/heroku.md
- Community installation methods:
- 'LinuxServer Docker Image': setup/docker-linuxserver.md
- 'Helm Chart': setup/kubernetes-helm.md
- 'YunoHost App': setup/yunohost.md
- 'Cloudron App': setup/cloudron.md
- 'Arch Linux Package': setup/arch-linux.md
- Guides:
- 'Reverse Proxy': guides/reverse-proxy.md
- Authentication:
- LDAP: guides/auth/ldap-ad.md
- OAuth: guides/auth/oauth.md
- SAML: guides/auth/saml.md
- SAML Keycloak: guides/auth/saml-keycloak.md
- SAML OneLogin: guides/auth/saml-onelogin.md
- GitHub: guides/auth/github.md
- GitLab: guides/auth/gitlab-self-hosted.md
- Keycloak: guides/auth/keycloak.md
- Mattermost: guides/auth/mattermost-self-hosted.md
- Nextcloud: guides/auth/nextcloud.md
- Twitter: guides/auth/twitter.md
- Media Backend:
- MinIO: guides/minio-image-upload.md
- S3: guides/s3-image-upload.md
- Migrate from Etherpad: guides/migrate-etherpad.md
- Migration Troubleshooting: guides/migration-troubleshooting.md
- Terms of Use Setup: guides/providing-terms.md
- Configuration: configuration.md
- References:
- 'HedgeDoc Flavored Markdown': references/hfm.md
- Developer:
- 'Getting Started': dev/getting-started.md
- API: dev/api.md
- 'Operational Transformation': dev/ot.md
- Webpack: dev/webpack.md
- 'Documentation': dev/documentation.md
- FAQ: faq.md
markdown_extensions:
- toc:
permalink: true
- pymdownx.highlight
- pymdownx.superfences
- mdx_truly_sane_lists
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- attr_list
- footnotes
- admonition
theme:
name: 'material'
language: en
favicon: images/favicon.png
logo: images/logo.svg
palette:
- media: "(prefers-color-scheme: light)"
scheme: light
primary: 'hedgedoc'
accent: 'hedgedoc'
toggle:
icon: material/lightbulb-outline
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: 'hedgedoc'
accent: 'hedgedoc'
toggle:
icon: material/lightbulb
name: Switch to light mode
features:
- navigation.tabs
- navigation.sections
- toc.integrate
font: false
extra_css:
- theme/styles/hedgedoc-custom.css
- theme/styles/roboto.css