StringSight/mkdocs.yml at main · lisadunlap/StringSight · 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
site_name: StringSight Documentation
site_description: Extract, cluster, and analyze behavioral properties from model traces
site_author: StringSight Team

# Repository
repo_name: StringSight
repo_url: https://github.com/lisadunlap/StringSight
edit_uri: edit/main/docs/

# Development server address
dev_addr: 127.0.0.1:8001

# Theme
theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/brightness-auto
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
  logo: assets/stringsight_logo.png
  favicon: assets/stringsight_logo.png
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - toc.follow
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

# Navigation
nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
  - User Guide:
    - Basic Usage: user-guide/basic-usage.md
    - Data Formats: user-guide/data-formats.md
    - Parameter Reference: user-guide/parameters.md
    - Configuration Guide: user-guide/configuration-guide.md
    - Output Files: user-guide/configuration.md
    - Visualization: user-guide/visualization.md
  - Troubleshooting: troubleshooting.md

# Plugins
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            heading_level: 2

# Markdown extensions
markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

# Extra CSS and JS
extra_css:
  - stylesheets/extra.css

# Copyright
copyright: Copyright &copy; 2025 StringSight Team