skillsaw/mkdocs.yml at main · stbenjam/skillsaw · 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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
site_name: "Skillsaw: Advanced Linter for Agent Context"
site_description: A configurable linter for agent skills, plugins, and AI coding assistant context
site_url: https://skillsaw.org
repo_url: https://github.com/stbenjam/skillsaw
repo_name: stbenjam/skillsaw

theme:
  name: material
  palette:
    # Palette toggle: follows system preference on first visit.
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - navigation.footer
    - navigation.tracking
    - search.highlight
    - search.suggest
    - search.share
    - content.code.copy
    - content.tabs.link
    - toc.follow
    - navigation.path
  logo: images/logo-only.png
  favicon: images/logo-only.png
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/stbenjam/skillsaw
      name: skillsaw on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/skillsaw/
      name: skillsaw on PyPI

extra_css:
  - stylesheets/custom.css

# Listing plugins disables the implicit default, so search must be explicit.
plugins:
  - search
  # Content rule pages moved from rules/content/<short>/ to the uniform
  # rules/<rule-id>/ scheme (#279) — keep the old URLs alive.
  - redirects:
      redirect_maps:
        rules/content/index.md: rules/content-intelligence.md
        rules/content/weak-language.md: rules/content-weak-language.md
        rules/content/tautological.md: rules/content-tautological.md
        rules/content/critical-position.md: rules/content-critical-position.md
        rules/content/redundant-with-tooling.md: rules/content-redundant-with-tooling.md
        rules/content/instruction-budget.md: rules/content-instruction-budget.md
        rules/content/negative-only.md: rules/content-negative-only.md
        rules/content/section-length.md: rules/content-section-length.md
        rules/content/contradiction.md: rules/content-contradiction.md
        rules/content/hook-candidate.md: rules/content-hook-candidate.md
        rules/content/actionability-score.md: rules/content-actionability-score.md
        rules/content/cognitive-chunks.md: rules/content-cognitive-chunks.md
        rules/content/embedded-secrets.md: rules/content-embedded-secrets.md
        rules/content/banned-references.md: rules/content-banned-references.md
        rules/content/inconsistent-terminology.md: rules/content-inconsistent-terminology.md
        rules/content/broken-internal-reference.md: rules/content-broken-internal-reference.md
        rules/content/unlinked-internal-reference.md: rules/content-unlinked-internal-reference.md
        rules/content/placeholder-text.md: rules/content-placeholder-text.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.mark
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

exclude_docs: |
  designs/

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Guides:
    - Autofixing: autofixing.md
    - Porting to Agent Plugins: porting.md
    - Baseline: baseline.md
    - Configuration: configuration.md
    - Repository Types: repo-types.md
    - CI Integration: ci.md
    - Pre-commit: pre-commit.md
    - CLI Reference: cli.md
    - Custom Rules: custom-rules.md
    - Rule Plugins: plugins.md
    - Scaffolding: scaffolding.md
    - Lint Tree: lint-tree.md
    - Supply Chain Protection: supply-chain-protection.md
  - Rules:
    - rules/index.md
    - AgentSkills: rules/agentskills.md
    - Agent Plugins: rules/agent-plugins.md
    - Claude Code: rules/claude.md
    - OpenAI Codex: rules/codex.md
    - Hooks: rules/hooks.md
    - Security: rules/security.md
    - MCP: rules/mcp.md
    - OpenClaw: rules/openclaw.md
    - Cursor: rules/cursor.md
    - Instruction Files: rules/instruction-files.md
    - Context Budget: rules/context-budget.md
    - Content Intelligence: rules/content-intelligence.md
    - CodeRabbit: rules/coderabbit.md
    - Promptfoo: rules/promptfoo.md
    - APM: rules/apm.md
    - Deprecated: rules/deprecated.md
  - Research: research.md