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

Files

Teknium ed10b32014 docs: list Hermes in supported integrations table (#2768 )

The Hermes Agent integration ships in the CLI (src/specify_cli/integrations/hermes/)
and is registered in the catalog, but the supported-agents table in the
integrations reference omitted it. Add the row so the docs match the shipped
integration.

2026-06-01 15:04:04 -05:00

community

Add spec-kit-linear extension to community catalog (#2795 )

2026-06-01 11:50:59 -05:00

concepts

docs: revamp landing page with four-pillar card layout (#2531 )

2026-05-12 17:39:38 -05:00

install

docs: fix broken pipx homepage URLs to point to pipx.pypa.io (#2670 )

2026-05-27 07:10:38 -05:00

reference

docs: list Hermes in supported integrations table (#2768 )

2026-06-01 15:04:04 -05:00

template/public

docs: revamp landing page with four-pillar card layout (#2531 )

2026-05-12 17:39:38 -05:00

.gitignore

Update files

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

docfx.json

docs: revamp landing page with four-pillar card layout (#2531 )

2026-05-12 17:39:38 -05:00

index.md

docs: update landing page stats and branch naming convention (#2727 )

2026-05-27 16:33:33 -05:00

installation.md

docs: fix broken pipx homepage URLs to point to pipx.pypa.io (#2670 )

2026-05-27 07:10:38 -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: document high-assurance spec workflow (#2518 )

2026-05-15 07:12:59 -05:00

README.md

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

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

toc.yml

docs: streamline install section and add community overview (#2561 )

2026-05-14 10:14:32 -05:00

upgrade.md

feat: add self-check tip to check output (#2574 )

2026-05-20 21:21:11 -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.