mirror of
https://github.com/github/spec-kit.git
synced 2026-07-03 12:28:06 +08:00
efdff310a2
Rewrite docs/index.md from a philosophy essay into a landing page organized around four pillars: Spec-driven by default, Use any coding agent, Make it your own, and Integrate into your organization. - Add hero section with GitHub Spec Kit branding and CTA buttons - Add 2x2 pillar card grid with GitHub Primer color accents - Add community stats section (96K stars, 200+ contributors, etc.) - Add navigation cards and footer install CTA - Move SDD philosophy content to docs/concepts/sdd.md - Add custom DocFX template overlay with card CSS and dark mode - Set landing layout for index.md via fileMetadata - Update toc.yml and docfx.json for new concepts section
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.