0049b1cd创建于 2025年12月5日历史提交
文件最后提交记录最后更新时间
Update files 7 个月前
feat(ci): add markdownlint-cli2 for consistent markdown formatting 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. 7 个月前
Update files 7 个月前
docs: reorganize upgrade documentation structure - Rename docs/upgrading-spec-kit.md to docs/upgrade.md for brevity - Update README and documentation index links to point to new upgrade guide - Update table of contents to use shorter "Upgrade" title - Simplify section headers in upgrade guide - Add Getting Started section back to docs/index.md with upgrade guide link Commit-generated-by: GitHub Copilot <github.copilot@github.com> Signed-off-by: Ashley Childress <6563688+anchildress1@users.noreply.github.com> 6 个月前
feat(ci): add markdownlint-cli2 for consistent markdown formatting 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. 7 个月前
feat(ci): add markdownlint-cli2 for consistent markdown formatting 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. 7 个月前
docs: Enhance quickstart guide with admonitions and examples - Convert blockquotes to GFM admonitions for better visibility - Add current directory initialization example - Expand process to 6 steps with clarify, analyze, checklist, implement - Update example with separate clarify commands - Add proper links in Next Steps Fixes #906, #472 Generated-by: GitHub Copilot <github.copilot@github.com> Signed-off-by: Ashley Childress <6563688+anchildress1@users.noreply.github.com> 6 个月前
docs: reorganize upgrade documentation structure - Rename docs/upgrading-spec-kit.md to docs/upgrade.md for brevity - Update README and documentation index links to point to new upgrade guide - Update table of contents to use shorter "Upgrade" title - Simplify section headers in upgrade guide - Add Getting Started section back to docs/index.md with upgrade guide link Commit-generated-by: GitHub Copilot <github.copilot@github.com> Signed-off-by: Ashley Childress <6563688+anchildress1@users.noreply.github.com> 6 个月前
Update Markdown formatting 5 个月前
README.md

Documentation

This folder contains the documentation source files for Spec Kit, built using DocFX.

Building Locally

To build the documentation locally:

  1. Install DocFX:

    dotnet tool install -g docfx
    
  2. Build the documentation:

    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.