ARIA/mkdocs.yml at main · antenore/ARIA · 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
site_name: ARIA Documentation
site_description: AI Responsibility and Integration Assistant
site_author: Antenore Gatta
repo_url: https://github.com/antenore/ARIA
repo_name: antenore/ARIA

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - search.suggest
    - search.highlight
  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

nav:
  - Home: index.md
  - Getting Started:
    - Quick Start: guides/getting-started.md
    - Working with Templates: guides/templates.md
    - Policy Inheritance: guides/inheritance.md
    - Policy Validation: guides/policy-validation.md
    - CLI Usage: guides/cli.md
    - Integration: guides/integration.md
    - Contributing: guides/contributing.md
    - License: guides/license.md
  - API Reference:
    - CLI API: api/cli.md
    - Policy API: api/policy.md
    - Templates API: api/templates.md
    - Validator API: api/validator.md
    - Configuration API: api/config.md
  - Technical Docs:
    - Policy Architecture: technical/policy.md
    - Template System: technical/templates.md
    - Validation System: technical/validation.md
    - Configuration: technical/configuration.md
    - Deployment: technical/deployment.md
  - CI/CD Integration:
    - GitHub Actions: ci/github-actions.md
    - GitLab CI: ci/gitlab-ci.md
    - Jenkins Pipeline: ci/jenkins.md
  - Examples:
    - Basic Policy: examples/basic-policy.yml
    - Inherited Policy: examples/inherited-policy.yml
    - Template Usage: examples/template-usage.yml
    - Policy Formats: examples/policy-formats.yml

markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
  - search
  - minify:
      minify_html: true
  - exclude:
      glob:
        - "README.md"

strict: false  # Disable strict mode for now until we fix all warnings

docs_dir: docs
site_dir: site