encoderfile/mkdocs.yml at main · mozilla-ai/encoderfile · 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
site_name: Encoderfile
site_url: https://mozilla-ai.github.io/encoderfile/
repo_url: https://github.com/mozilla-ai/encoderfile

theme:
  logo: assets/favicon.svg
  icon:
    repo: fontawesome/brands/github
  favicon: assets/favicon.svg
  name: material
  language: en
  palette:
    scheme: slate
    primary: grey
    accent: deep orange
  features:
    - navigation.instant
    - navigation.tabs

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Building Encoderfiles:
    - Building with Docker: building_encoderfiles/docker.md
  - Python Library:
    - Building with Python: python/building-with-python.md
    - API Reference: python/api-reference.md
  - Cookbooks:
      - Token Classification (NER): cookbooks/token-classification-ner.md
      - MCP Integration: cookbooks/mcp-integration.md
      - Matryoshka Embeddings: cookbooks/matryoshka-embeddings.md
      - Local RAG: cookbooks/local-rag.md
      - CVE Semantic Search: cookbooks/qdrant-cve-search.md
  - Code of Conduct: CODE_OF_CONDUCT.md
  - Contributing: CONTRIBUTING.md
  - Transforms:
      - Transforms: transforms/index.md
      - Reference: transforms/reference.md
  - Reference:
    - Encoderfile File Format: reference/file_format.md
    - CLI Reference: reference/cli.md
    - API Reference: reference/api-reference.md
    - Building Guide: reference/building.md

plugins:
  - include-markdown

markdown_extensions:
  - footnotes
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences:
      custom_fences:
            - name: mermaid
              class: mermaid
              format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details