site_name: HedgeDoc 2 Docs
site_url: https://docs.hedgedoc.dev
repo_url: https://github.com/hedgedoc/hedgedoc
site_description: 'HedgeDoc 2 Documentation'
site_author: 'HedgeDoc Developers'
docs_dir: content
edit_uri: https://github.com/hedgedoc/hedgedoc/edit/develop/docs/content/
nav:
  - Home: index.md
  - 'Getting started':
    - Overview: getting-started/index.md
    - 'Install HedgeDoc': getting-started/setup.md
    - 'Create a user': getting-started/user.md
    - 'Create a note': getting-started/first-note.md
    - 'Explore notes': getting-started/explore.md
    - 'Create a presentation': getting-started/first-presentation.md
  - 'How-to guides':
    - Overview: guides/index.md
    - 'Reverse Proxy': guides/reverse-proxy.md
    - Backup: guides/backup.md
    - Authentication: guides/auth.md
    - Database: guides/database.md
  - 'Configuration':
    - Overview: config/index.md
    - General: config/general.md
    - Notes: config/notes.md
    - Database: config/database.md
    - Authentication:
      - Overview: config/auth/index.md
      - 'Local accounts': config/auth/local.md
      - LDAP: config/auth/ldap.md
      - 'OpenID Connect (OIDC)': config/auth/oidc.md
    - Customization: config/customization.md
    - Media Backends:
      - 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
    - Integrations: config/integrations.md
  - Development:
    - Overview: development/index.md
    - Guides:
      - Setup: development/guides/setup.md
      - 'Frontend setup': development/guides/frontend.md
      - 'Build docker images': development/guides/docker.md
      - 'Build Documentation': development/guides/documentation.md
      - 'LDAP test environment': development/guides/auth/ldap.md
    - Concepts:
      - Overview: development/concepts/index.md
      - Notes: development/concepts/notes.md
      - 'User Profiles': development/concepts/user-profiles.md
      - Config: development/concepts/config.md
      - 'API Auth': development/concepts/api-auth.md
      - Events: development/concepts/events.md
  - References:
      - Overview: references/index.md
      - 'HFM Syntax': references/hfm.md
      - API: references/api.md
  - FAQ: faq/index.md
markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - attr_list
  - footnotes
  - mdx_truly_sane_lists
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