speja/mkdocs.yml at main · ru551n/speja · 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
# The published documentation (Read the Docs). It covers what speja adds on top of VSG; the
# VSG interface itself is documented by VSG and linked to from the home page, so that the two
# cannot drift apart.
site_name: speja
site_description: A VHDL formatter and linter in Rust, compatible with VSG.
site_url: https://speja.readthedocs.io/
repo_url: https://github.com/ru551n/speja
repo_name: ru551n/speja
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/speja-logo-dark.png
  favicon: assets/favicon.png
  features:
    - navigation.sections
    - navigation.top
    - content.code.copy
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle: {icon: material/weather-night, name: Dark mode}
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle: {icon: material/weather-sunny, name: Light mode}

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - tables
  - toc: {permalink: true}
  - pymdownx.highlight
  - pymdownx.superfences

# Working notes that restate VSG's own reference. They stay in the repository for development
# but are not published: VSG documents its rules and its configuration.
nav:
  - Home: index.md
  - Getting started:
      - Quick start: quick-start.md
      - Coming from VSG: migrating-from-vsg.md
  - Formatter:
      - Formatting: formatting.md
      - Line folding: line-folding.md
      - Folding coverage: line-folding-coverage.md
      - Format on save: editors.md
      - Language server: lsp.md
      - Editing in VS Code: vscode-editing.md
      - MCP server: mcp.md
      - Claude Code plugin: claude-code.md
  - Static analysis:
      - Overview: lint.md
      - Project setup: project-setup.md
      - Rule reference: rule-reference.md
      - Native rules in detail: native-rules.md
      - Waivers: waivers.md
  - CI and automation:
      - GitHub Action: github-action.md
      - GitLab CI: gitlab-ci.md
      - Report formats: reports.md
      - Running in an airgap: airgapped.md
  - VSG compatibility:
      - Measured compatibility: compatibility.md
      - Rule status: rule-status.md
  - Reference:
      - CLI reference: cli.md
      - Rule counts: rule-counts.md
      - VSG configuration model: vsg-config.md
  - Developer documentation:
      - Architecture: architecture.md
      - VHDL frontend: vhdl-frontend.md
      - Performance: performance.md
      - Releasing: releasing.md
      - Upstream notes: upstream-notes.md
  - Roadmap: roadmap.md