2023-10-11 11:47:57 +00:00
|
|
|
site_name: HedgeDoc 2 Docs
|
2023-07-02 20:31:04 +00:00
|
|
|
site_url: https://docs.hedgedoc.dev
|
2021-01-04 12:07:44 +00:00
|
|
|
repo_url: https://github.com/hedgedoc/hedgedoc
|
2023-07-02 20:31:04 +00:00
|
|
|
site_description: 'HedgeDoc 2 Documentation'
|
2021-01-04 12:07:44 +00:00
|
|
|
site_author: 'HedgeDoc Developers'
|
|
|
|
|
docs_dir: content
|
2023-07-02 20:31:04 +00:00
|
|
|
edit_uri: https://github.com/hedgedoc/hedgedoc/edit/develop/docs/content/
|
2021-01-04 12:07:44 +00:00
|
|
|
nav:
|
|
|
|
|
- Home: index.md
|
2023-07-02 20:31:04 +00:00
|
|
|
- Tutorials:
|
|
|
|
|
- Overview: tutorials/index.md
|
|
|
|
|
- Setup: tutorials/setup.md
|
|
|
|
|
- 'Create a user': tutorials/user.md
|
|
|
|
|
- 'Create a note': tutorials/first-note.md
|
|
|
|
|
- 'Create a presentation': tutorials/first-presentation.md
|
|
|
|
|
- 'How-to guides':
|
|
|
|
|
- Overview: how-to/index.md
|
|
|
|
|
- 'Reverse Proxy': how-to/reverse-proxy.md
|
|
|
|
|
- Backup: how-to/backup.md
|
|
|
|
|
- Authentication: how-to/auth.md
|
|
|
|
|
- Database: how-to/database.md
|
|
|
|
|
- Develop:
|
|
|
|
|
- Setup: how-to/develop/setup.md
|
|
|
|
|
- 'Frontend setup': how-to/develop/frontend.md
|
|
|
|
|
- 'Build docker images': how-to/develop/docker.md
|
|
|
|
|
- 'Build Documentation': how-to/develop/documentation.md
|
|
|
|
|
- 'LDAP test environment': how-to/develop/auth/ldap.md
|
|
|
|
|
- 'Core concepts':
|
|
|
|
|
- Overview: concepts/index.md
|
|
|
|
|
- Notes: concepts/notes.md
|
|
|
|
|
- 'User Profiles': concepts/user-profiles.md
|
|
|
|
|
- Config: concepts/config.md
|
|
|
|
|
- 'API Auth': concepts/api-auth.md
|
|
|
|
|
- Events: concepts/events.md
|
2021-03-25 21:20:45 +00:00
|
|
|
- References:
|
2023-07-02 20:31:04 +00:00
|
|
|
- Overview: references/index.md
|
|
|
|
|
- 'HFM Syntax': references/hfm.md
|
|
|
|
|
- Configuration:
|
|
|
|
|
- Overview: references/config/index.md
|
|
|
|
|
- General: references/config/general.md
|
|
|
|
|
- Notes: references/config/notes.md
|
|
|
|
|
- Database: references/config/database.md
|
|
|
|
|
- Authentication:
|
|
|
|
|
- 'Local accounts': references/config/auth/local.md
|
|
|
|
|
- LDAP: references/config/auth/ldap.md
|
|
|
|
|
- Customization: references/config/customization.md
|
|
|
|
|
- Media Backends:
|
|
|
|
|
- Azure: references/config/media/azure.md
|
|
|
|
|
- Filesystem: references/config/media/filesystem.md
|
|
|
|
|
- imgur: references/config/media/imgur.md
|
|
|
|
|
- S3: references/config/media/s3.md
|
|
|
|
|
- WebDAV: references/config/media/webdav.md
|
|
|
|
|
- Integrations: references/config/integrations.md
|
|
|
|
|
- FAQ: faq/index.md
|
2021-01-04 12:07:44 +00:00
|
|
|
markdown_extensions:
|
|
|
|
|
- toc:
|
|
|
|
|
permalink: true
|
2021-02-04 20:50:38 +00:00
|
|
|
- admonition
|
2023-07-02 20:31:04 +00:00
|
|
|
- pymdownx.details
|
|
|
|
|
- pymdownx.superfences
|
2021-02-04 20:50:38 +00:00
|
|
|
- attr_list
|
2021-03-28 18:24:45 +00:00
|
|
|
- footnotes
|
2023-07-02 20:31:04 +00:00
|
|
|
- mdx_truly_sane_lists
|
2021-01-04 12:07:44 +00:00
|
|
|
theme:
|
|
|
|
|
name: 'material'
|
|
|
|
|
language: en
|
|
|
|
|
favicon: images/favicon.png
|
|
|
|
|
logo: images/logo.svg
|
|
|
|
|
palette:
|
2021-04-17 10:42:03 +00:00
|
|
|
- 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
|
2021-01-04 12:07:44 +00:00
|
|
|
features:
|
|
|
|
|
- navigation.tabs
|
|
|
|
|
- navigation.sections
|
|
|
|
|
- toc.integrate
|
2021-01-05 21:55:00 +00:00
|
|
|
font: false
|
2021-01-04 12:07:44 +00:00
|
|
|
|
|
|
|
|
extra_css:
|
2021-01-05 21:55:00 +00:00
|
|
|
- theme/styles/hedgedoc-custom.css
|
|
|
|
|
- theme/styles/roboto.css
|
