fortitude/mkdocs.yml at main · PlasmaFAIR/fortitude · 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
site_name: Fortitude
site_url: !ENV READTHEDOCS_CANONICAL_URL
site_description: An extremely fast Fortran linter, built on ruff and tree-sitter
repo_url: https://github.com/PlasmaFAIR/fortitude
repo_name: fortitude
theme:
  name: material
  features:
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.path
    - navigation.top
    - navigation.tracking
    - toc.follow
    - toc.integrate
  # https://squidfunk.github.io/mkdocs-material/customization/
  custom_dir: docs/overrides
  logo: assets/fortitude_logo_white.png
  favicon: assets/favicon.ico
  palette:
  - media: (prefers-color-scheme)
    toggle:
      icon: material/brightness-auto
      name: Switch to light mode
  - media: '(prefers-color-scheme: light)'
    toggle:
      icon: material/brightness-7
      name: Switch to dark mode
  - media: '(prefers-color-scheme: dark)'
    scheme: slate
    toggle:
      icon: material/brightness-4
      name: Switch to system preference

# Include extra CSS to make some style adjustments
extra_css:
  - stylesheets/readthedocs.css

# Include extra JS to setup Read the Docs addons integrations
extra_javascript:
    - javascript/readthedocs.js
    - javascript/extra.js

markdown_extensions:
  - admonition
  - pymdownx.details
  - toc:
      anchorlink: true
      anchorlink_class: "toclink"
  - pymdownx.snippets:
  - pymdownx.magiclink:
  - attr_list:
  - md_in_html:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite:
  - pymdownx.superfences:
      custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format
  - markdown.extensions.attr_list:
  - pymdownx.keys:
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - footnotes

nav:
  - Overview: index.md
  - Tutorial: tutorial.md
  - Installing Fortitude: installation.md
  - The Fortitude Linter: linter.md
  - Editors:
    - Editor Integration: editors/index.md
    - Setup: editors/setup.md
    - Features: editors/features.md
    - Settings: editors/settings.md
  - Configuring Fortitude: configuration.md
  - Preview: preview.md
  - Rules: rules.md
  - Settings: settings.md
  - Integrations: integrations.md
  - FAQ: faq.md
  - Changelog: release_notes.md
  - Contributing: contributing.md

# Too many rules, don't include them in the left-hand nav bar
not_in_nav: |
  /rules/*

plugins:
  - search
  - include-markdown