ennoia/mkdocs.yml at main · vunone/ennoia · 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
site_name: Ennoia
site_description: Declarative Document Indexing (DDI) Schemas for RAG — LLM-powered pre-indexing and hybrid retrieval.
site_url: https://vunone.github.io/ennoia/
repo_url: https://github.com/vunone/ennoia
repo_name: vunone/ennoia
edit_uri: edit/main/docs/

strict: true

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - toc.follow
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight
  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

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_source: false
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            separate_signature: true
            merge_init_into_class: true
            show_signature_annotations: true
            signature_crossrefs: true
            filters:
              - "!^_"
  - mike:
      canonical_version: latest

markdown_extensions:
  - admonition
  - attr_list
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details

extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/vunone/ennoia
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/ennoia/

nav:
  - Home: index.md
  - Guides:
    - Quickstart: quickstart.md
    - Concepts: concepts.md
    - Schema authoring: schemas.md
    - Filter language: filters.md
    - Adapters: adapters.md
    - Stores: stores.md
    - CLI: cli.md
    - Servers (REST + MCP): serve.md
    - Testing: testing.md
  - Reference:
    - API reference: api-reference.md
  - Cookbook:
    - MCP agent loop: cookbook/mcp-agent.md
    - Custom adapters and stores: cookbook/custom-adapter.md
    - Product-discovery benchmark: cookbook/product-discovery-benchmark.md