fm-playground/mkdocs.yml at main · fm4se/fm-playground · 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
site_name: FM Playground Documentation
site_description: Comprehensive documentation for the Formal Methods Playground
site_url: https://play.formal-methods.net/docs/


# Repository
repo_name: fm4se/fm-playground
repo_url: https://github.com/fm4se/fm-playground
edit_uri: "edit/main/docs/"

nav:
  - User Guide: index.md
  - Developer Guide:
    - Overview: developer-guide/index.md
    - Setup Guide: developer-guide/tailered-playground/index.md
    - Project Structure: developer-guide/tailered-playground/project-structure.md
    - Development:
      - Adding Tools: development/adding-tools.md
      - Language Servers:
        - Overview: development/language-servers.md
        - Langium Implementation: development/langium-language-servers.md
        - External LSP Integration: development/external-language-servers.md
      - Deployment: development/deployment.md
      - API Reference: development/api-reference.md
  - Release Notes: CHANGELOG.md

# Configuration
theme:
  name: material
  custom_dir: docs/overrides
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.share
    - content.code.copy
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - md_in_html
  - tables
  - footnotes
  - meta

# Customization
extra:
  version:
    provider: mike
    default: latest
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/fm4se/fm-playground
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/playlist?list=PLGyeoukah9NYq9ULsIuADG2r2QjX530nf

plugins:
  - search