neptune/mkdocs.yml at main · devopsfactory-io/neptune · 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: Neptune
site_description: Terraform and OpenTofu PR automation with GitHub Actions
site_url: https://devopsfactory-io.github.io/neptune
repo_url: https://github.com/devopsfactory-io/neptune
repo_name: devopsfactory-io/neptune
edit_uri: edit/main/docs/
docs_dir: docs

theme:
  name: material
  logo: assets/logo-icon.svg
  favicon: assets/logo-icon.svg
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - search.highlight
    - search.suggest
    - content.action.edit
    - content.code.copy
    - content.code.annotate

nav:
  - Home: README.md
  - Getting Started:
      - Terramate Stacks: getting-started-terramate.md
      - Local Stacks: getting-started-local-stacks.md
      - Installation: installation.md
      - Workflow Comparison: workflow-comparison.md
  - User Guide:
      - Usage: usage.md
      - Configuration: configuration.md
      - Object Storage: object-storage.md
      - GitHub App & Lambda: github-app-and-lambda.md
  - Contributing: development.md

plugins:
  - search

extra:
  analytics:
    provider: google
    property: G-PLACEHOLDER
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/devopsfactory-io/neptune
      name: Neptune on GitHub

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - toc:
      permalink: true