hypernate/mkdocs.yml at main · LF-Decentralized-Trust-labs/hypernate · 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
site_name: Hypernate
site_url: https://lf-decentralized-trust-labs.github.io/hypernate
repo_url: https://github.com/LF-Decentralized-Trust-labs/hypernate
repo_name: LF-Decentralized-Trust-labs/hypernate
edit_uri: edit/main/docs/
strict: true

theme:
  name: material
  palette:
    primary: indigo
    accent: indigo
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.share
    - toc.follow

# Python-Markdown requires 4-space nested-list indentation by default and
# silently flattens the 2-space form that CommonMark/GFM accept. Override it
# so lists render the same here as on GitHub. truly_sane stays off to keep
# every other rendering behavior identical to vanilla Python-Markdown.
# See docs/contributing/documentation.md#markdown-conventions
markdown_extensions:
  - mdx_truly_sane_lists:
      truly_sane: false
      nested_indent: 2

plugins:
  - search
  - mike:
      alias_type: symlink
      canonical_version: latest

extra:
  version:
    provider: mike
    default: latest

nav:
  - Home: index.md
  - Getting Started:
      - Overview: getting-started/index.md
      - Installation: getting-started/installation.md
      - Quickstart: getting-started/quickstart.md
  - Concepts:
      - Overview: concepts/index.md
      - Registry: concepts/registry.md
      - Middleware: concepts/middleware.md
      - Annotations: concepts/annotations.md
  - Guides:
      - CI/CD: guides/cicd.md
  - API Reference:
      - Registry: api/registry.md
      - Annotations: api/annotations.md
  - Contributing:
      - Overview: contributing/index.md
      - Reporting Issues: contributing/issues.md
      - Working with the Code: contributing/development.md
      - Submitting Pull Requests: contributing/pull-requests.md
      - Contributing with AI Agents: contributing/ai-agents.md
      - Contributing to the Docs: contributing/documentation.md
      - Maintainers: contributing/maintainers.md
  - References:
      - Citing: references/citing.md