knowledge-platform/mkdocs.yml at main · Final-State-Press/knowledge-platform · 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
106
107
108
109
110
111
112
113
114
115
116
117
site_name: Knowledge Platform
site_description: Modular graph-first knowledge-work application
site_author: Matt Briggs

# Run from the project root: mkdocs serve  /  mkdocs build
docs_dir: site
site_dir: docs

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - toc.follow
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
  palette:
    - scheme: default
      primary: black
      accent: deep orange
    - scheme: slate
      primary: black
      accent: deep orange

markdown_extensions:
  - admonition
  - codehilite
  - toc:
      permalink: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - tables

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]   # relative to the project root
          options:
            show_source: true
            show_root_heading: true
            show_category_heading: true
            heading_level: 3
            show_signature_annotations: true
            separate_signature: true
            docstring_style: google

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.min.js
  - javascripts/mermaid.js

nav:
  - Home: index.md

  - Project:
    - Roadmap: project/roadmap.md

  - User Guides:
    - Working with Graphs: guides/user-guide.md
    - Outline Module: guides/outline-module.md
    - Use Cases: guides/use-cases.md

  - Module Development:
    - Building a Module: development/module-development.md

  - API Reference:
    - Core:
      - Overview: api/core.md
      - Identifiers: api/core/identifiers.md
      - Node: api/core/node.md
      - Edge: api/core/edge.md
      - Graph: api/core/graph.md
      - Transaction: api/core/transaction.md
      - Engine: api/core/engine.md
    - Domain:
      - Overview: api/domain.md
      - Graph Type System: api/domain/graph_type.md
      - Type Registry: api/domain/registry.md
    - Services:
      - Overview: api/services.md
      - Interfaces (Protocols): api/services/interfaces.md
      - GraphService: api/services/graph_service.md
      - WorkspaceService: api/services/workspace_service.md
    - Persistence:
      - Overview: api/persistence.md
      - SQLite Repository: api/persistence/store.md
    - Workspace:
      - Workspace: api/workspace.md
    - Modules:
      - IModule Protocol: api/modules/base.md
      - ModuleRegistry: api/modules/registry.md
      - Outline Module: api/modules/outline.md
    - UI:
      - Overview: api/ui.md
      - AppEventBus: api/ui/events.md
      - Application Bootstrap: api/ui/app.md

  - Contributing:
    - Updating the Docs: guides/working-with-mkdocs.md