kbs/mkdocs.yml at main · MadBomber/kbs · 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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# MkDocs Configuration for KBS Documentation
site_name: KBS - Knowledge-Based Systems for Ruby
site_description: A Ruby implementation of the RETE algorithm for production rule systems with persistent blackboard memory
site_author: Dewayne VanHoozer
site_url: https://madbomber.github.io/kbs
copyright: Copyright &copy; 2024 Dewayne VanHoozer

# Repository information
repo_name: madbomber/kbs
repo_url: https://github.com/madbomber/kbs
edit_uri: edit/main/docs/

# Configuration
theme:
  name: material

  # Color scheme - Default to light mode
  palette:
    # Palette toggle for light mode (default)
    - scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  # Typography
  font:
    text: Roboto
    code: Roboto Mono

  # Theme features
  features:
    # Navigation
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.path
    - navigation.indexes
    - navigation.top

    # Table of contents
    - toc.follow

    # Search
    - search.suggest
    - search.highlight
    - search.share

    # Header
    - header.autohide

    # Content
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips
    - content.action.edit
    - content.action.view

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'

# Extensions
markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      title: On this page

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: madbomber
      repo: kbs
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Extra CSS and JavaScript
extra_css:
  - assets/css/custom.css

extra_javascript:
  - assets/js/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

# Social media and extra configuration
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/madbomber/kbs
      name: KBS on GitHub
    - icon: fontawesome/solid/gem
      link: https://rubygems.org/gems/kbs
      name: KBS on RubyGems

  version:
    provider: mike

# Navigation
nav:
  - Home:
      - index.md
      - What is aKnowledge Base?: what-is-a-knowledge-base.md
      - What is a Fact?: what-is-a-fact.md
      - What is a Rule?: what-is-a-rule.md
  - Installation: installation.md
  - Quick Start: quick-start.md
  - Architecture:
      - architecture/index.md
      - RETE Algorithm: architecture/rete-algorithm.md
      - Blackboard System: architecture/blackboard.md
      - Network Structure: architecture/network-structure.md
  - Guides:
      - guides/index.md
      - Getting Started: guides/getting-started.md
      - Writing Rules: guides/writing-rules.md
      - DSL Reference: guides/dsl.md
      - Working with Facts: guides/facts.md
      - Pattern Matching: guides/pattern-matching.md
      - Variable Binding: guides/variable-binding.md
      - Negation: guides/negation.md
      - Blackboard Memory: guides/blackboard-memory.md
      - Persistence Options: guides/persistence.md
  - Examples: examples/index.md
  - Advanced:
      - advanced/index.md
      - Performance Tuning: advanced/performance.md
      - Custom Persistence: advanced/custom-persistence.md
      - Debugging: advanced/debugging.md
      - Testing Rules: advanced/testing.md
  - API Reference:
      - api/index.md
      - ReteEngine: api/engine.md
      - Facts: api/facts.md
      - Rules: api/rules.md
      - Blackboard: api/blackboard.md