Skip to content

Commit a12b048

Browse files
committed
Add mkdocs configuration for documentation site
Configure Material for MkDocs with: - Light/dark theme toggle - Navigation features (expand, footer, instant, sections) - Code copy/select functionality - Admonition, tabs, and emoji extensions
1 parent 0ef8be6 commit a12b048

1 file changed

Lines changed: 62 additions & 0 deletions

File tree

mkdocs.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
site_name: Project CodeGuard
2+
site_description: Project CodeGuard is an AI model-agnostic security framework and ruleset that embeds secure-by-default practices into AI coding workflows (generation and review). It ships core security rules, translators for popular coding agents, and validators to test rule compliance.
3+
site_author: Cisco AI-enabled Security Engineering, Security and Trust
4+
site_url: https://project-codeguard.org
5+
6+
theme:
7+
name: material
8+
# logo: assets/placeholder_codeguard.png
9+
# favicon: assets/placeholder_codeguard.png
10+
font:
11+
text: Inter
12+
code: JetBrains Mono
13+
palette:
14+
# Palette toggle for light mode
15+
- media: "(prefers-color-scheme: light)"
16+
scheme: default
17+
primary: blue
18+
accent: cyan
19+
toggle:
20+
icon: material/brightness-7
21+
name: Switch to dark mode
22+
# Palette toggle for dark mode
23+
- media: "(prefers-color-scheme: dark)"
24+
scheme: slate
25+
primary: blue
26+
accent: cyan
27+
toggle:
28+
icon: material/brightness-4
29+
name: Switch to light mode
30+
features:
31+
- navigation.expand
32+
- navigation.footer
33+
- navigation.instant
34+
- navigation.sections
35+
- navigation.top
36+
- search.highlight
37+
- search.suggest
38+
- content.code.copy
39+
- content.code.select
40+
repo_url: https://github.com/project-codeguard/rules
41+
repo_name: project-codeguard/rules
42+
# edit_uri: ""
43+
44+
nav:
45+
- Home: index.md
46+
- Getting Started: getting-started.md
47+
- Custom Rules: custom-rules.md
48+
- FAQ: faq.md
49+
markdown_extensions:
50+
- admonition
51+
- attr_list
52+
- md_in_html
53+
- pymdownx.emoji:
54+
emoji_index: !!python/name:material.extensions.emoji.twemoji
55+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
56+
- pymdownx.keys
57+
- pymdownx.tabbed:
58+
alternate_style: true
59+
60+
extra:
61+
generator: false
62+

0 commit comments

Comments
 (0)