Build and manage DocFX documentation sites with customizable build configurations, multi-platform support, and automatic API generation.
This skill helps you build and manage DocFX documentation sites, following established conventions for structure, style, and build processes.
Guides you through working with DocFX documentation projects, including:
When asked to build the documentation:
1. **Identify the target platform:**
- Windows: Use `.\build.cmd` or `.\build.ps1`
- Unix/Mac: Use `./build.sh`
2. **Apply build options if specified:**
- Clean metadata: Add `-cleanMetadata` flag
- Custom port: Add `-port <number>` flag
- Clean dependencies only: Add `-cleanOnly` flag
- Example: `./build.ps1 -cleanMetadata -port 8080`
3. **Execute the appropriate build command** using the Bash tool
When adding or modifying documentation:
1. **Understand the directory structure:**
- `/articles/` - Main documentation content
- `/api/` - Auto-generated API documentation (do not edit manually)
- `toc.yml` - Table of Contents configuration
- `index.md` - Section entry points
- `docfx.json` - DocFX generator configuration
2. **When creating new content:**
- Place articles in `/articles/` or appropriate subdirectory
- Use lowercase filenames with hyphens for spaces (e.g., `getting-started.md`)
- Group related articles in common directories
- Always update the corresponding `toc.yml` file to include the new content
3. **When modifying existing content:**
- Maintain existing formatting patterns
- Keep titles concise and descriptive
- Ensure changes are reflected in relevant `toc.yml` files
Apply these conventions to all documentation:
1. **Markdown formatting:**
- Use `#` syntax for headings with a single space after (e.g., `# Heading`)
- Follow established patterns in similar documents
2. **File naming:**
- Lowercase only
- Alphanumeric characters
- Hyphens for spaces
- `.md` extension
3. **Content organization:**
- Keep titles concise and descriptive
- Organize related articles in common directories
- Update `toc.yml` when adding new pages
4. **Content restrictions:**
- Do not include GTA:V modding content (this belongs in the wiki)
When working with DocFX configuration:
1. **`toc.yml` files:**
- Define navigation structure
- Must be updated when adding new content
- Use consistent indentation and structure
2. **`docfx.json`:**
- Controls DocFX generator behavior
- Defines input/output paths
- Configures metadata and build options
3. **`index.md` files:**
- Serve as entry points for sections
- Should provide overview and navigation
**Building on Windows:**
```bash
.\build.ps1 -cleanMetadata
```
**Building on Unix with custom port:**
```bash
./build.sh -port 8080
```
**Creating new documentation:**
1. Create `articles/new-feature.md`
2. Add entry to `articles/toc.yml`:
```yaml
- name: New Feature
href: new-feature.md
```
3. Build to verify: `./build.sh`
Leave a review
No reviews yet. Be the first to review this skill!
# Download SKILL.md from killerskills.ai/api/skills/docfx-documentation-builder/raw