refract/mkdocs.yml at main · hrtsx/refract · 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
site_name: Refract
site_description: Fast Ruby LSP, type-aware, debugger-equipped.
site_url: https://refract.dev/docs
repo_url: https://github.com/hrtsx/refract
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - search.suggest
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo

markdown_extensions:
  - admonition
  - attr_list
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - tables

nav:
  - Home: index.md
  - Install: install.md
  - Architecture: architecture.md
  - Benchmark: BENCHMARK.md
  - LSP capabilities: lsp_capabilities.md
  - MCP tools: mcp_tools.md
  - Configure:
      - Multi-Ruby: configure/multi_ruby.md
      - AI / LLM: configure/llm.md
      - Telemetry: configure/telemetry.md
  - Migrate:
      - From ruby-lsp: migrate/from-ruby-lsp.md
      - From Solargraph: migrate/from-solargraph.md
      - From RubyMine: migrate/from-rubymine.md
      - From Sorbet (alone): migrate/from-sorbet.md
      - From Steep (alone): migrate/from-steep.md
  - Extensions:
      - Authoring guide: extensions/AUTHORING.md
      - Protocol: extensions/PROTOCOL.md