hedgedoc/docs/mkdocs.yml
David Mehren 520d0933cb docs: add getting started guide
Signed-off-by: David Mehren <git@herrmehren.de>
2023-03-25 13:05:42 +01:00

72 lines
2 KiB
YAML

site_name: HedgeDoc 2
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
- Configuration:
- Configuration: config/index.md
- Media:
- Azure: config/media/azure.md
- Filesystem: config/media/filesystem.md
- imgur: config/media/imgur.md
- S3: config/media/s3.md
- WebDAV: config/media/webdav.md
- Interface:
- Toolbar: interface/toolbar.md
- References:
- 'HedgeDoc Flavored Markdown': references/hfm.md
- Development:
- Getting Started: dev/getting-started.md
- Frontend: dev/setup/frontend.md
- Development Notes: dev/dev_notes.md
- Docker: dev/docker.md
- Writing Docs: dev/documentation.md
- Design Documents:
- API Authentication: dev/design_docs/api_auth.md
- Configuration: dev/design_docs/config.md
- Events: dev/design_docs/events.md
- Notes: dev/design_docs/notes.md
- 'User Profiles & Authentication': dev/design_docs/user_profiles.md
- FAQ: https://hedgedoc.org/faq
markdown_extensions:
- toc:
permalink: true
- admonition
- attr_list
- footnotes
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