qlever-docs/mkdocs.yml at master · qlever-dev/qlever-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json
site_name: QLever Documentation
site_url: https://qlever.dev

# Navigation on the left side
nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - Benchmarks: benchmarks.md
  - Compliance: compliance.md
  - Publications: publications.md
  - Use Cases: use-cases.md
  - FAQ: faq.md
  - Troubleshooting: troubleshooting.md
  - Reference:
    - Qleverfile settings: qleverfile.md
    - GeoSPARQL support: geosparql.md
    - Update: update.md
    - Materialized Views: materialized-views.md
    - Rebuild index: rebuild-index.md
    - Text search: text-search.md
    - Path search: path-search.md
    # - Datasets: qlever-control/datasets.md

repo_url: https://github.com/ad-freiburg/qlever
edit_uri: https://github.com/qlever-dev/qlever-docs/edit/master/docs
site_description: Documentation for the QLever graph database
site_author: The QLever authors
copyright: >
  Copyright &copy; 2025-2026 The QLever authors
theme:
  name: material
  language: en
  logo: assets/logo.png
  favicon: assets/favicon.ico
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/
  features:
    - navigation.tracking
    # Sections
    - navigation.sections
    - navigation.expand
    # Not compatible with toc.integrate
    #- navigation.indexes
    - toc.follow
    - toc.integrate
    - navigation.top
    - search.suggest
    - search.highlight
    - navigation.footer
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.tabs.link

  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

plugins:
  - privacy
  # Note on Cookies and Github: https://github.com/squidfunk/mkdocs-material/discussions/4666
  - search
  - social
  - git-revision-date-localized:
      enable_creation_date: false
      type: timeago
  # - git-committers:
  #     repository: qlever-dev/qlever-docs
  #     branch: master

# https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#document-contributors
# or https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#document-authors
# https://squidfunk.github.io/mkdocs-material/reference/

extra_javascript:
  - js/qlever-demo.js

extra_css:
  - css/qlever-demo.css

extra:
  version:
    provider: mike
  social:
    # Note: the icons are the path in site-packages/material/templates/.icons/...
    - icon: material/github
      link: https://github.com/ad-freiburg
    - icon: material/language-python
      link: https://pypi.org/project/qlever
    - icon: material/web
      link: https://ad.informatik.uni-freiburg.de

markdown_extensions:
    # Captions for many types of blocks
    - pymdownx.blocks.caption
    # Emojis with :name:
    - pymdownx.emoji:
        emoji_index: !!python/name:material.extensions.emoji.twemoji
        emoji_generator: !!python/name:material.extensions.emoji.to_svg
    - pymdownx.magiclink:
        repo_url_shorthand: true
        user: ad-freiburg
        repo: qlever
        normalize_issue_symbols: true
    # Syntax highlighting
    - pymdownx.highlight:
        anchor_linenums: true
    - pymdownx.superfences
    # Convert some symbols to unicode (e.g. (c) to ©)
    - pymdownx.smartsymbols
    # Tabs in a document
    - pymdownx.tabbed:
        alternate_style: true
    # Collapsible callouts
    - admonition
    - pymdownx.details
    - attr_list
    - footnotes
    - md_in_html