chatkit-node-backend-sdk/mkdocs.yml at master · EvoTechMike/chatkit-node-backend-sdk · 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: ChatKit Node.js SDK
theme:
  name: material
  features:
    - content.code.copy
    - content.code.select
    - navigation.sections
    - navigation.path
    - navigation.expand
    - content.code.annotate
  palette:
    primary: black
  logo: docs/assets/logo.svg
  favicon: docs/images/favicon-platform.svg

repo_name: EvoTechMike/chatkit-node-backend-sdk
repo_url: https://github.com/EvoTechMike/chatkit-node-backend-sdk

plugins:
  - search

nav:
  - Home: index.md
  - Guides:
      - Server Integration: server.md
      - Actions: actions.md
      - Widgets: widgets.md
  - API Reference:
      - Overview: api/README.md
      - Classes:
          - ChatKitServer: api/classes/ChatKitServer.md
          - Store: api/classes/Store.md
          - AttachmentStore: api/classes/AttachmentStore.md
          - StreamingResult: api/classes/StreamingResult.md
          - NonStreamingResult: api/classes/NonStreamingResult.md
      - Errors:
          - StreamError: api/classes/StreamError.md
          - CustomStreamError: api/classes/CustomStreamError.md
          - NotFoundError: api/classes/NotFoundError.md
          - StoreNotFoundError: api/classes/StoreNotFoundError.md
  - ChatKit JS Docs: https://openai.github.io/chatkit-js/

markdown_extensions:
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences

extra_css:
  - stylesheets/extra.css

docs_dir: docs