Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
183 lines (175 loc) · 5.84 KB
/
Copy pathmkdocs.yml
File metadata and controls
183 lines (175 loc) · 5.84 KB
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
site_name: Codefang
site_url: https://sumatoshi-tech.github.io/codefang
site_description: The heavy lifter for your codebase — deep code analysis through structure and history.
site_author: Sumatoshi Tech
repo_url: https://github.com/Sumatoshi-tech/codefang
repo_name: Sumatoshi-tech/codefang
edit_uri: edit/main/site/
docs_dir: site
site_dir: build
copyright: Copyright © 2024-2026 Sumatoshi Tech — Apache 2.0 License
theme:
name: material
logo: assets/logo.png
favicon: assets/favicon.png
icon:
repo: fontawesome/brands/github
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.expand
- navigation.path
- navigation.top
- navigation.indexes
- search.suggest
- search.highlight
- search.share
- content.code.copy
- content.code.annotate
- content.tabs.link
- toc.follow
palette:
- media: "(prefers-color-scheme: light)"
scheme: codefang
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: codefang-dark
toggle:
icon: material/brightness-4
name: Switch to light mode
font:
text: JetBrains Mono
code: JetBrains Mono
plugins:
- search
- minify:
minify_html: true
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- toc:
permalink: true
toc_depth: 3
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/Sumatoshi-tech/codefang
generator: false
extra_css:
- stylesheets/extra.css
- stylesheets/stars.css
nav:
- Home: index.md
- Getting started:
- Installation: getting-started/installation.md
- Quick start: getting-started/quickstart.md
- First analysis: getting-started/first-analysis.md
- User guide:
- CLI reference: guide/cli-reference.md
- Configuration: guide/configuration.md
- Output formats: guide/output-formats.md
- Data analytics & DWH: guide/data-analytics.md
- How to:
- Analyze a monorepo: how-to/analyze-a-monorepo.md
- Run in CI: how-to/run-in-ci.md
- Read a burndown chart: how-to/read-a-burndown-chart.md
- Analyze a bare repository: how-to/analyze-a-bare-repo.md
- Attach an MCP client: how-to/attach-an-mcp-client.md
- Analyzers:
- Overview: analyzers/index.md
- Static analyzers:
- Complexity: analyzers/complexity.md
- Cohesion: analyzers/cohesion.md
- Halstead: analyzers/halstead.md
- Comments: analyzers/comments.md
- Imports (static): analyzers/imports.md
- Clones: analyzers/clones.md
- Composition: analyzers/composition.md
- History analyzers:
- Burndown: analyzers/burndown.md
- Developers: analyzers/developers.md
- Couples: analyzers/couples.md
- File history: analyzers/file-history.md
- Quality: analyzers/quality.md
- Sentiment: analyzers/sentiment.md
- Shotness: analyzers/shotness.md
- Typos: analyzers/typos.md
- Anomaly detection: analyzers/anomaly.md
- Reference:
- Glossary: glossary.md
- Examples:
- Kubernetes analysis: examples/index.md
- Architecture:
- Overview: architecture/overview.md
- UAST system: architecture/uast.md
- History pipeline: architecture/streaming-pipeline.md
- Explanation:
- Static analyzers:
- Complexity metrics: explanation/complexity.md
- Cohesion metrics: explanation/cohesion.md
- Halstead metrics: explanation/halstead.md
- Documentation coverage: explanation/comments.md
- Import analysis: explanation/imports.md
- Clone detection: explanation/clones.md
- History analyzers:
- Code burndown: explanation/burndown.md
- Developer analysis: explanation/developers.md
- File and developer coupling: explanation/couples.md
- File history analysis: explanation/file-history.md
- Code quality over time: explanation/quality.md
- Comment sentiment: explanation/sentiment.md
- Structural hotness: explanation/shotness.md
- Typo detection: explanation/typos.md
- Temporal anomaly detection: explanation/anomaly.md
- Integrations:
- MCP server: integrations/mcp.md
- Docker & GitHub actions: integrations/docker-and-actions.md
- AI agents: integrations/ai-agents.md
- Operations:
- Observability: operations/observability.md
- Large-scale scanning: operations/large-scale-scanning.md
- ADRs:
- Record architecture decisions: adr/0001-record-architecture-decisions.md
- Two-binary split (UAST + Codefang): adr/0002-two-binary-split-uast-codefang.md
- libgit2 via cgo: adr/0003-libgit2-via-cgo.md
- Release notes:
- Overview: release-notes/index.md
- Upcoming release: release-notes/unreleased.md
- Contributing:
- How to contribute: contributing/index.md
- Code of conduct: contributing/code-of-conduct.md
- Changelog: contributing/changelog.md