pipelineconductor/mkdocs.yml at main · plexusone/pipelineconductor · 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
site_name: PipelineConductor
site_description: Orchestrate and harmonize multi-repo CI/CD pipelines with policy-driven automation
site_url: https://plexusone.github.io/pipelineconductor
repo_url: https://github.com/plexusone/pipelineconductor
repo_name: plexusone/pipelineconductor

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    # Dark mode first (PlexusOne default)
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy

extra_css:
  - https://plexusone.dev/css/plexusone-mkdocs.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: installation.md
      - Quick Start: quickstart.md
  - CLI Reference:
      - Overview: cli/overview.md
      - scan: cli/scan.md
      - check: cli/check.md
      - remediate: cli/remediate.md
      - apply: cli/apply.md
      - validate: cli/validate.md
      - Configuration: cli/config.md
  - Policies:
      - Overview: policies/overview.md
      - Cedar Syntax: policies/cedar-syntax.md
      - Built-in Policies: policies/builtin.md
      - Writing Policies: policies/writing.md
      - Examples: policies/examples.md
  - Profiles:
      - Overview: profiles/overview.md
      - Built-in Profiles: profiles/builtin.md
      - Custom Profiles: profiles/custom.md
  - Reports:
      - Output Formats: reports/formats.md
      - SARIF Integration: reports/sarif.md
  - Integration:
      - GitHub Actions: integration/github-actions.md
      - CI/CD Workflows: integration/workflows.md
  - Development:
      - Contributing: contributing.md
      - Roadmap: roadmap.md
  - API Reference: https://pkg.go.dev/github.com/plexusone/pipelineconductor
  - Releases:
      - Changelog: changelog.md
      - v0.2.0: releases/v0.2.0.md
      - v0.1.0: releases/v0.1.0.md

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