site_name: linthis
site_description: Fast, cross-platform multi-language linter and formatter
site_url: https://linthis.readthedocs.io
repo_url: https://github.com/zhlinh/linthis
repo_name: linthis
theme:
name: material
logo: assets/logo.svg
favicon: assets/favicon.svg
palette:
- scheme: default
primary: blue
accent: light blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: blue
accent: light blue
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tabs
- navigation.sections
- search.suggest
- content.code.copy
plugins:
- search
- i18n:
docs_structure: suffix
languages:
- locale: en
name: English
default: true
build: true
- locale: zh
name: 简体中文
build: true
nav_translations:
Home: 首页
Getting Started: 快速入门
Installation: 安装
Quick Start: 快速开始
Configuration: 配置
Video Tutorials: 视频教程
Languages: 语言支持
Overview: 概览
Features: 功能特性
Plugin System: 插件系统
Auto Sync: 自动同步
Self Update: 自更新
Git Hooks: Git Hooks
Agent Hooks: AI 编程助手集成
Watch Mode: 监视模式
AI Fix: AI 修复
Report: 报告与分析
Reference: 参考文档
CLI Commands: CLI 命令
Development: 开发指南
Contributing: 贡献指南
Roadmap: 路线图
Changelog: 更新日志
Design Docs: 设计文档
Config CLI Design: 配置 CLI 设计
Init Hooks Design: 初始化 Hooks 设计
Ruff Integration: Ruff 集成
Tasks: 任务
markdown_extensions:
- pymdownx.highlight
- pymdownx.superfences
- admonition
- toc:
permalink: true
nav:
- Home: index.md
- Getting Started:
- Installation: getting-started/installation.md
- Quick Start: getting-started/quickstart.md
- Configuration: getting-started/configuration.md
- Video Tutorials: getting-started/videos.md
- Languages:
- Overview: languages/index.md
- Rust: languages/rust.md
- Python: languages/python.md
- TypeScript: languages/typescript.md
- JavaScript: languages/javascript.md
- Go: languages/go.md
- Java: languages/java.md
- C++: languages/cpp.md
- Swift: languages/swift.md
- Kotlin: languages/kotlin.md
- Objective-C: languages/objc.md
- Lua: languages/lua.md
- Dart: languages/dart.md
- Shell: languages/shell.md
- Ruby: languages/ruby.md
- PHP: languages/php.md
- Scala: languages/scala.md
- C#: languages/csharp.md
- Features:
- Plugin System: features/plugins.md
- AI Fix: features/ai-fix.md
- Auto Sync: features/auto-sync.md
- Self Update: features/self-update.md
- Git Hooks: features/git-hooks.md
- Agent Hooks: features/agent-hooks.md
- Watch Mode: features/watch-mode.md
- Report: features/report.md
- Reference:
- CLI Commands: reference/cli.md
- Configuration: reference/configuration.md
- Development:
- Contributing: development/contributing.md
- Roadmap: development/roadmap.md
- Changelog: development/changelog.md
- Design Docs:
- Config CLI Design: config-cli-design.md
- Init Hooks Design: init-hooks-design.md
- Ruff Integration: plan-ruff-integration.md
- Tasks: tasks.md