mirror of
https://github.com/github/spec-kit.git
synced 2026-07-03 12:28:06 +08:00
4384338ec1
* Add SpecKit Companion extension to community catalog Add companion extension submitted by @alfredoperez to: - extensions/catalog.community.json (alphabetical order) - docs/community/extensions.md community extensions table Closes #2926 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Address review: multi-line tools format, add vscode tag Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Manfred Riem <mnriem@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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:8080to view the documentation.
Structure
docfx.json- DocFX configuration fileindex.md- Main documentation homepagetoc.yml- Table of contents configurationinstallation.md- Installation guidequickstart.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.