mirror of
https://github.com/github/spec-kit.git
synced 2026-01-30 20:52:03 +00:00
33a07969c3
Add automated markdown linting to ensure consistent formatting across all markdown files in the repository. Changes: - Add .markdownlint-cli2.jsonc configuration - Create .github/workflows/lint.yml for CI/CD integration - Fix all 908 existing markdown errors across 27 files - Enforce ATX-style headings and asterisk emphasis - Set consistent 2-space list indentation This prevents markdown errors after project initialization and maintains high documentation quality standards.
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.