mirror of https://github.com/github/spec-kit.git synced 2026-07-03 20:36:23 +08:00

Files

flipthedog 92186124f3 Add install directory to docfx.json file references (#2522 )

* Add install directory to docfx.json file references

Fixed broken link for https://github.github.com/spec-kit/install/uv.md

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

2026-05-12 09:48:43 -05:00

community

Preset: Add game-narrative-writing preset to community catalog (#2454 )

2026-05-12 07:35:37 -05:00

install

docs: Add uv installation guide and inline callouts (#2465 )

2026-05-06 15:05:14 -05:00

reference

fix(kiro-cli): replace literal $ARGUMENTS with prose fallback (#2482 )

2026-05-12 07:48:25 -05:00

.gitignore

Update files

2025-10-14 11:52:26 -07:00

docfx.json

Add install directory to docfx.json file references (#2522 )

2026-05-12 09:48:43 -05:00

index.md

docs: reorganize upgrade documentation structure

2025-11-06 18:01:16 -05:00

installation.md

docs: Add uv installation guide and inline callouts (#2465 )

2026-05-06 15:05:14 -05:00

local-development.md

docs: replace deprecated --ai flag with --integration in all documentation (#2359 )

2026-04-24 16:04:04 -05:00

quickstart.md

docs: replace deprecated --ai flag with --integration in all documentation (#2359 )

2026-04-24 16:04:04 -05:00

README.md

feat(ci): add markdownlint-cli2 for consistent markdown formatting

2025-10-20 00:49:15 +02:00

toc.yml

docs: Add uv installation guide and inline callouts (#2465 )

2026-05-06 15:05:14 -05:00

upgrade.md

docs: clarify CLI upgrade discovery (#2519 )

2026-05-12 07:19:40 -05:00

README.md

Documentation

This folder contains the documentation source files for Spec Kit, built using DocFX.

Building Locally

To build the documentation locally:

Install DocFX:
```
dotnet tool install -g docfx
```
Build the documentation:
```
cd docs
docfx docfx.json --serve
```
Open your browser to http://localhost:8080 to view the documentation.

Structure

docfx.json - DocFX configuration file
index.md - Main documentation homepage
toc.yml - Table of contents configuration
installation.md - Installation guide
quickstart.md - Quick start guide
_site/ - Generated documentation output (ignored by git)

Deployment

Documentation is automatically built and deployed to GitHub Pages when changes are pushed to the main branch. The workflow is defined in .github/workflows/docs.yml.