magic/mkdocs.yml at main · tink3rlabs/magic · 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
site_name: magic
site_description: Common building blocks for Go microservices, so your service code can focus on business logic.
site_url: https://tink3rlabs.github.io/magic/
repo_url: https://github.com/tink3rlabs/magic
repo_name: tink3rlabs/magic
edit_uri: edit/main/docs/

exclude_docs: |
  superpowers/

theme:
  name: material
  icon:
    logo: material/auto-fix
  favicon: assets/favicon.png
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - content.code.copy
    - content.action.edit
    - content.action.view
    - search.suggest
    - search.highlight
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: black
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: white
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Quick start: getting-started.md
  - Tutorial: tutorial.md
  - Lucene: lucene.md
  - Storage: storage.md
  - Observability: observability.md
  - Contributing: contributing.md

not_in_nav: |
  observability-internals.md

plugins:
  - search
  - llmstxt:
      full_output: llms-full.txt
      sections:
        Overview:
          - index.md
        Guides:
          - getting-started.md
          - tutorial.md
          - lucene.md
          - storage.md
          - observability.md
        Contributing:
          - contributing.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      url_download: true
      url_timeout: 10
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

extra:
  version:
    provider: mike
    default: latest