github-org-management-examples/mkdocs.yml at main · AutomationDojo/github-org-management-examples · 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
site_name: GitHub Organization Management Examples
site_description: Example configurations and templates for GitHub organization management with Terraform
site_author: Automation Dojo
site_url: https://github-org-management.automationdojo.org/

repo_name: automationDojo/github-org-management-examples
repo_url: https://github.com/automationDojo/github-org-management-examples
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

plugins:
  - search
  - glightbox

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/automationDojo

nav:
  - Home: index.md
  - Overview: overview.md
  - Prerequisites: prerequisites.md
  - Modules:
      - Organization Settings: modules/organization.md
      - Repositories: modules/repositories.md
      - Rulesets: modules/rulesets.md
      - Teams: modules/teams.md
  - Guides:
      - Getting Started: guides/getting-started.md
      - Authentication: guides/authentication.md
      - Deployment: guides/deployment.md
  - Examples:
      - Basic Setup: examples/basic-setup.md
      - Advanced Configuration: examples/advanced-config.md
      - Best Practices: examples/best-practices.md
  - Reference:
      - YAML Schema: reference/yaml-schema.md
      - Troubleshooting: reference/troubleshooting.md