jsrun/mkdocs.yml at main · imfing/jsrun · 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
site_name: jsrun
site_description: JavaScript runtime for Python powered by V8 and Rust
site_author: imfing
site_url: https://imfing.github.io/jsrun

repo_name: imfing/jsrun
repo_url: https://github.com/imfing/jsrun
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/logo.svg
  favicon: assets/logo.svg
  features:
    - content.code.copy
    - content.code.select
    - navigation.path
    - navigation.sections
    - navigation.expand
    - navigation.footer
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.annotate
  palette:
    - scheme: default
      primary: black
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Introduction: index.md
  - Quick Start: quickstart.md
  - Documentation:
      - Concepts:
          - Runtime: concepts/runtime.md
          - Code Evaluation: concepts/evaluation.md
          - Type Conversion: concepts/types.md
      - Guides:
          - Bindings: guides/bindings.md
          - Modules: guides/modules.md
          - Advanced:
              - WebAssembly: guides/advanced/webassembly.md
              - Snapshots: guides/advanced/snapshots.md
              - Inspector: guides/advanced/inspector.md
  - Use Cases:
      - Code Playground: use-cases/playground.md
      - AI Agent Sandbox: use-cases/ai-agent.md
      - Plugin System: use-cases/plugin-system.md
      - Serverless Runtime: use-cases/serverless-runtime.md
      - Workflow Orchestration: use-cases/workflow.md
  - API Reference:
      - jsrun Module: api/jsrun.md
      - Runtime: api/runtime.md
      - RuntimeConfig: api/config.md
      - Types: api/types.md
  - Contributing:
      - Development: contributing/development.md
      - Architecture: contributing/architecture.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: ["docs/stubs"]
          options:
            relative_crossrefs: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            group_by_category: false
            heading_level: 3
            docstring_style: google
            show_source: false
            find_stubs_package: true

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

extra_css:
  - stylesheets/extra.css

watch:
  - docs
  - mkdocs.yml