hypercache/mkdocs.yml at main · hyp3rd/hypercache · 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
---
# MkDocs configuration for the GitHub Pages docs site.
# Build:    mkdocs build --strict
# Preview:  mkdocs serve
# Deploy:   pushed automatically by .github/workflows/docs.yml on main.

site_name: HyperCache
site_description: Distributed in-memory cache for Go — sharded, replicated, observable.
site_author: hyp3rd
site_url: https://hyp3rd.github.io/hypercache/

repo_name: hyp3rd/hypercache
repo_url: https://github.com/hyp3rd/hypercache
edit_uri: edit/main/docs/

# Strict mode in CI catches broken links / missing pages on PR. Local
# `mkdocs serve` ignores this so authoring stays low-friction.
strict: false

theme:
  name: material
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.tracking
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.action.edit
  icon:
    repo: fontawesome/brands/github
    logo: material/database

plugins:
  - search
  - include-markdown
  - glightbox
  # Renders embedded OpenAPI specs via `!!swagger ...!!` markers.
  # `docs/api.md` uses this to render the binary's embedded spec
  # (injected into the docs build by `_mkdocs/hooks.py:on_files`).
  - swagger-ui-tag

# Build-time hooks. _hooks.py rewrites repo-relative links to source
# files (e.g. `../pkg/foo.go`) into absolute GitHub URLs so the same
# markdown renders correctly both on github.com and on the rendered
# Pages site.
hooks:
  - _mkdocs/hooks.py

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      permalink_title: Anchor link to this section
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.keys

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/hyp3rd/hypercache
  generator: false

nav:
  - Home: index.md
  - Getting Started:
      - Quickstart: quickstart.md
      - 5-Node Cluster: cluster.md
      - Kubernetes (Helm): helm.md
  - Operations:
      - Runbook: operations.md
      - Server Binary: server.md
  - Architecture:
      - Distributed Backend: distributed.md
  - Reference:
      - API Reference: api.md
      - Changelog: changelog.md
      - RFCs: rfcs/index.md