chat-bricks/mkdocs.yml at main · Agent-One-Lab/chat-bricks · 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
site_name: Chat Bricks
site_description: Flexible chat template system for LLMs and VLMs
repo_url: https://github.com/Agent-One-Lab/chat-bricks
docs_dir: docs

theme:
  name: material
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
  palette:
    - scheme: default
      primary: agl
      accent: agl
    - toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: agl
      accent: agl
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Quick Start:
    - Basic Usage: quick_start/use_template.md
  - About Chat Bricks:
    - Overview: chat_bricks/index.md
    - Core Components: chat_bricks/core_components.md
  - How to use Chat Bricks:
    - Usage Guide: how_to_use/basic_usage.md
    - HuggingFace Templates: how_to_use/huggingface_templates.md
    - Custom Templates: how_to_use/custom_templates.md
    - Advanced Features: how_to_use/advanced_features.md
    - Vision Templates: how_to_use/vision_templates.md
    - More Examples: how_to_use/examples.md

  - API References:
    - Chat API: api_references/chat.md
    - Template API: api_references/template.md

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  - git-authors
  # - macros:
  #     module_name: docs/macros/source_links
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_section_style: list
            docstring_style: google
            heading_level: 3
  - autorefs
  - mike:
      version_selector: true
      css_dir: css
      javascript_dir: js
      canonical_version: latest

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - tables
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji

extra_css:
  - stylesheets/extra.css