pegium/mkdocs.yml at main · ydaveluy/pegium · 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
site_name: Pegium
site_description: C++20 toolkit for building parsers, AST/CST pipelines, validation, references, formatting, and language servers.
site_url: https://ydaveluy.github.io/pegium/
repo_url: https://github.com/ydaveluy/pegium
repo_name: ydaveluy/pegium
edit_uri: edit/main/docs/
docs_dir: docs
site_dir: site
strict: true

theme:
  name: material
  language: en
  custom_dir: overrides
  logo: assets/icon.svg
  favicon: assets/icon.svg
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - content.action.edit
    - content.action.view
  palette:
    - scheme: default
      primary: blue grey
      accent: light blue

plugins:
  - search

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets:
      base_path:
        - .

extra_css:
  - stylesheets/extra.css

nav:
  - Home: index.md
  - Introduction:
      - What is Pegium?: introduction/index.md
      - Features: introduction/features.md
      - Showcases: introduction/showcases.md
      - Why Pegium: introduction/why-pegium.md
      - Pegium Mental Model: introduction/mental-model.md
  - Learn:
      - learn/index.md
      - Create a Project: learn/workflow/scaffold.md
      - Build a Language End-to-End: learn/walkthrough.md
      - Test Your Language: learn/test-your-language.md
      - Run a Language Headlessly: learn/consume-the-ast.md
      - Build a Language:
          - build-a-language/index.md
          - Define the AST: build-a-language/ast-and-cst.md
          - Grammar Essentials: build-a-language/grammar.md
          - Debugging a Grammar: build-a-language/debugging-grammar.md
          - References and Scoping: build-a-language/references-and-scoping.md
          - Validation: build-a-language/validation.md
          - Formatting: build-a-language/formatting.md
          - LSP Services: build-a-language/lsp-services.md
          - Integrate with VS Code: build-a-language/editor-integration.md
          - Workspace Lifecycle: build-a-language/workspace.md
  - Recipes:
      - recipes/index.md
      - Multiple Languages: recipes/multiple-languages.md
      - Formatting: recipes/custom-formatter.md
      - Scoping:
          - recipes/scoping/index.md
          - Qualified Names: recipes/scoping/qualified-names.md
          - Custom Scope Provider: recipes/custom-scope-provider.md
      - Validation:
          - recipes/validation/index.md
          - Dependency Loops: recipes/validation/dependency-loops.md
          - Custom Validator: recipes/custom-validator.md
      - Performance:
          - recipes/performance/index.md
          - Caches: recipes/performance/caches.md
      - Custom LSP Features: recipes/custom-lsp-features.md
  - Reference:
      - reference/index.md
      - Glossary: reference/glossary.md
      - Configuration Services: reference/configuration-services.md
      - Completion Provider: reference/completion-provider.md
      - Document Lifecycle: reference/document-lifecycle.md
      - Semantic Model: reference/semantic-model.md
      - Grammar Reference: reference/grammar-reference.md
      - Formatter DSL: reference/formatter-dsl.md
  - FAQ: faq.md
  - Examples:
      - examples/index.md
      - Arithmetics: examples/arithmetics.md
      - DomainModel: examples/domainmodel.md
      - Requirements: examples/requirements.md
      - Statemachine: examples/statemachine.md