mirrors/hedgedoc
1
0
Fork 0
mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-09-19 07:28:48 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 9
hedgedoc/docs/mkdocs.yml

96 lines
3.1 KiB
YAML
Raw Permalink Normal View History

fix(docs): set docs title Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2023-10-11 07:47:57 -04:00
site_name: HedgeDoc 2 Docs
docs: restructure documentation This rewrite follows the principles of https://diataxis.fr/ Co-authored-by: Erik Michelson <github@erik.michelson.eu> Signed-off-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2023-07-02 16:31:04 -04:00
site_url: https://docs.hedgedoc.dev
Move docs into subdirectory to make mkdocs work in a subdirectory Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> (cherry picked from commit eaeb88401d07687eb3db8c273f7a4c0ed31ec153) Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-04 07:07:44 -05:00
repo_url: https://github.com/hedgedoc/hedgedoc
docs: restructure documentation This rewrite follows the principles of https://diataxis.fr/ Co-authored-by: Erik Michelson <github@erik.michelson.eu> Signed-off-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2023-07-02 16:31:04 -04:00
site_description: 'HedgeDoc 2 Documentation'
Move docs into subdirectory to make mkdocs work in a subdirectory Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> (cherry picked from commit eaeb88401d07687eb3db8c273f7a4c0ed31ec153) Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-04 07:07:44 -05:00
site_author: 'HedgeDoc Developers'
docs_dir: content
docs: restructure documentation This rewrite follows the principles of https://diataxis.fr/ Co-authored-by: Erik Michelson <github@erik.michelson.eu> Signed-off-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2023-07-02 16:31:04 -04:00
edit_uri: https://github.com/hedgedoc/hedgedoc/edit/develop/docs/content/
Move docs into subdirectory to make mkdocs work in a subdirectory Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> (cherry picked from commit eaeb88401d07687eb3db8c273f7a4c0ed31ec153) Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-04 07:07:44 -05:00
nav:
- Home: index.md
docs: restructure documentation This rewrite follows the principles of https://diataxis.fr/ Co-authored-by: Erik Michelson <github@erik.michelson.eu> Signed-off-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2023-07-02 16:31:04 -04: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
Docs: Add hedgedoc flavored markdown reference Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-25 17:20:45 -04:00
- References:
docs: restructure documentation This rewrite follows the principles of https://diataxis.fr/ Co-authored-by: Erik Michelson <github@erik.michelson.eu> Signed-off-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2023-07-02 16:31:04 -04: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:
feat(auth): refactor auth, add oidc Thanks to all HedgeDoc team members for the time discussing, helping with weird Nest issues, providing feedback and suggestions! Co-authored-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2024-03-22 21:10:25 -04:00
- Overview: references/config/auth/index.md
docs: restructure documentation This rewrite follows the principles of https://diataxis.fr/ Co-authored-by: Erik Michelson <github@erik.michelson.eu> Signed-off-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2023-07-02 16:31:04 -04:00
- 'Local accounts': references/config/auth/local.md
- LDAP: references/config/auth/ldap.md
feat(auth): refactor auth, add oidc Thanks to all HedgeDoc team members for the time discussing, helping with weird Nest issues, providing feedback and suggestions! Co-authored-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2024-03-22 21:10:25 -04:00
- 'OpenID Connect (OIDC)': references/config/auth/oidc.md
docs: restructure documentation This rewrite follows the principles of https://diataxis.fr/ Co-authored-by: Erik Michelson <github@erik.michelson.eu> Signed-off-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2023-07-02 16:31:04 -04:00
- 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
Move docs into subdirectory to make mkdocs work in a subdirectory Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> (cherry picked from commit eaeb88401d07687eb3db8c273f7a4c0ed31ec153) Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-04 07:07:44 -05:00
markdown_extensions:
- toc:
permalink: true
Update docs with hint about 2.0 development Replace the old docs index page with a hint where the (for now) 'real' docs can be found and that HedgeDoc 2.0 is still in development. Signed-off-by: David Mehren <git@herrmehren.de>
2021-02-04 15:50:38 -05:00
- admonition
docs: restructure documentation This rewrite follows the principles of https://diataxis.fr/ Co-authored-by: Erik Michelson <github@erik.michelson.eu> Signed-off-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2023-07-02 16:31:04 -04:00
- pymdownx.details
- pymdownx.superfences
Update docs with hint about 2.0 development Replace the old docs index page with a hint where the (for now) 'real' docs can be found and that HedgeDoc 2.0 is still in development. Signed-off-by: David Mehren <git@herrmehren.de>
2021-02-04 15:50:38 -05:00
- attr_list
Docs: Add footnotes extension Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-03-28 14:24:45 -04:00
- footnotes
docs: restructure documentation This rewrite follows the principles of https://diataxis.fr/ Co-authored-by: Erik Michelson <github@erik.michelson.eu> Signed-off-by: Philip Molares <philip.molares@udo.edu> Signed-off-by: Erik Michelson <github@erik.michelson.eu>
2023-07-02 16:31:04 -04:00
- mdx_truly_sane_lists
Move docs into subdirectory to make mkdocs work in a subdirectory Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> (cherry picked from commit eaeb88401d07687eb3db8c273f7a4c0ed31ec153) Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-04 07:07:44 -05:00
theme:
name: 'material'
language: en
favicon: images/favicon.png
logo: images/logo.svg
palette:
Documentation: Add toggleable dark theme The dark theme is mostly built on top of the mkdocs slate theme. Signed-off-by: Philip Molares <philip.molares@udo.edu> Co-Authored-by: Tilman Vatteroth <git@tilmanvatteroth.de> (cherry picked from commit 60251d89ee1de87b6df00ca7a91529d4acb6ee46) Signed-off-by: Philip Molares <philip.molares@udo.edu>
2021-04-17 06:42:03 -04: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
Move docs into subdirectory to make mkdocs work in a subdirectory Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> (cherry picked from commit eaeb88401d07687eb3db8c273f7a4c0ed31ec153) Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-04 07:07:44 -05:00
features:
- navigation.tabs
- navigation.sections
- toc.integrate
Several theme changes (#659) * Several theme changes - Add max width of 1440px - Rename css file - Fix edit button - Add local Roboto font Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> (cherry picked from commit 5bdb39241374afc3da801a4032ebc306f8562035)
2021-01-05 16:55:00 -05:00
font: false
Move docs into subdirectory to make mkdocs work in a subdirectory Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> (cherry picked from commit eaeb88401d07687eb3db8c273f7a4c0ed31ec153) Signed-off-by: David Mehren <git@herrmehren.de>
2021-01-04 07:07:44 -05:00
extra_css:
Several theme changes (#659) * Several theme changes - Add max width of 1440px - Rename css file - Fix edit button - Add local Roboto font Signed-off-by: Tilman Vatteroth <tilman.vatteroth@tu-dortmund.de> (cherry picked from commit 5bdb39241374afc3da801a4032ebc306f8562035)
2021-01-05 16:55:00 -05:00
- theme/styles/hedgedoc-custom.css
- theme/styles/roboto.css
Reference in a new issue Copy permalink