https://github.com/marceloeatworld/mdbook-ai-skill
Auto-updated mdBook documentation for AI coding assistants — works with 33+ tools via the Agent Skills standard (SKILL.md)
https://github.com/marceloeatworld/mdbook-ai-skill
agent-skills ai ai-coding-assistant claude-code cursor documentation github-copilot markdown mdbook rust skill-md windsurf
Last synced: 11 days ago
JSON representation
Auto-updated mdBook documentation for AI coding assistants — works with 33+ tools via the Agent Skills standard (SKILL.md)
- Host: GitHub
- URL: https://github.com/marceloeatworld/mdbook-ai-skill
- Owner: marceloeatworld
- Created: 2026-04-09T00:45:18.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-20T07:19:05.000Z (26 days ago)
- Last Synced: 2026-05-20T11:07:12.635Z (26 days ago)
- Topics: agent-skills, ai, ai-coding-assistant, claude-code, cursor, documentation, github-copilot, markdown, mdbook, rust, skill-md, windsurf
- Language: Shell
- Size: 58.6 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mdBook AI Skill
Auto-updated [mdBook](https://rust-lang.github.io/mdBook/) documentation for AI coding assistants.
Uses the open [Agent Skills](https://agentskills.io) standard (SKILL.md). Works with **33+ AI coding assistants** including Claude Code, Cursor, Windsurf, GitHub Copilot, OpenAI Codex, Gemini CLI, Amp, OpenCode, Cline, Aider, Goose, Roo Code, and [many more](https://agentskills.io/clients).
References are **auto-generated** daily from the official [mdBook guide](https://github.com/rust-lang/mdBook/tree/master/guide) via GitHub Actions.
## Install
### Quick start
```bash
# Claude Code (global)
git clone https://github.com/marceloeatworld/mdbook-ai-skill.git ~/.claude/skills/mdbook
# Cursor
git clone https://github.com/marceloeatworld/mdbook-ai-skill.git .cursor/skills/mdbook
# Windsurf
git clone https://github.com/marceloeatworld/mdbook-ai-skill.git .windsurf/skills/mdbook
# Cross-agent standard
git clone https://github.com/marceloeatworld/mdbook-ai-skill.git .agents/skills/mdbook
```
### With the install script
```bash
curl -fsSL https://raw.githubusercontent.com/marceloeatworld/mdbook-ai-skill/main/install.sh | bash -s -- --claude
curl -fsSL https://raw.githubusercontent.com/marceloeatworld/mdbook-ai-skill/main/install.sh | bash -s -- --cursor
```
Run `./install.sh --help` for all options.
## Update
```bash
git -C pull
```
## What it covers
| Category | Topics |
|----------|--------|
| **Getting Started** | Installation, creating a book, reading books |
| **CLI** | init, build, watch, serve, test, clean, completions |
| **Book Format** | SUMMARY.md syntax, Markdown extensions, mdBook-specific features, MathJax |
| **Configuration** | book.toml (general, preprocessors, renderers, environment variables) |
| **Theme** | Custom themes, index.hbs, syntax highlighting, editor integration |
| **For Developers** | Writing preprocessors, writing backends (Rust API) |
| **Deployment** | GitHub Actions, GitLab CI, GitHub Pages |
## How it works
The `SKILL.md` maps topics to reference files. The `references/` directory contains the **full unmodified guide** from the mdBook repository.
A [GitHub Actions workflow](.github/workflows/update-references.yml) runs daily to keep references in sync.
## Structure
```
mdbook-ai-skill/
├── SKILL.md # Topic -> reference routing table
├── install.sh # Multi-tool install script
├── scripts/
│ └── generate-references.sh # Fetches guide and generates references
├── .github/workflows/
│ └── update-references.yml # Daily auto-update
└── references/ # Auto-generated from mdBook guide
├── .wiki-version # Source commit tracker
├── cli.md # All CLI commands
├── configuration.md # book.toml reference
├── summary-format.md # SUMMARY.md syntax
├── theme.md # Theme customization
└── ...
```
## Credits
- [mdBook](https://github.com/rust-lang/mdBook) by the Rust team and contributors