mirror of
https://github.com/github/spec-kit.git
synced 2026-01-30 12:42:02 +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.
36 lines
899 B
Markdown
36 lines
899 B
Markdown
# Documentation
|
|
|
|
This folder contains the documentation source files for Spec Kit, built using [DocFX](https://dotnet.github.io/docfx/).
|
|
|
|
## Building Locally
|
|
|
|
To build the documentation locally:
|
|
|
|
1. Install DocFX:
|
|
|
|
```bash
|
|
dotnet tool install -g docfx
|
|
```
|
|
|
|
2. Build the documentation:
|
|
|
|
```bash
|
|
cd docs
|
|
docfx docfx.json --serve
|
|
```
|
|
|
|
3. 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`.
|