Skip to content

Commit e3b2c45

Browse files
authored
docs: add CNAME file for GitHub Pages custom domain (#88)
* docs: improve documentation structure with unified command chains and cross-linking (#79) Co-authored-by: Dominikus Nold <[email protected]> * docs: add integrations overview guide (optional task 6.4) - Create integrations-overview.md with comprehensive overview of all integrations - Add links from integration guides to integrations-overview.md - Add link to integrations-overview.md in docs/README.md - Complete optional task 6.4 from improve-documentation-structure change * docs: fix linting errors in integrations-overview.md - Fix MD036 warnings by converting emphasis to proper headings - Fix MD040 warning by adding language specifier to code block * docs: simplify README and add links to new documentation - Update website links to specfact.com / .io / .dev - Add GitHub Pages docs link: https://nold-ai.github.io/specfact-cli/ - Remove version info section (avoids outdated info) - Simplify content - remove verbose sections, add links to docs instead - Add links to new documentation: - Command Chains Reference - Common Tasks Quick Reference - AI IDE Workflow Guide - Integrations Overview - Improve onboarding with clear path for new users * docs: add prominent SpecFact domain links with context - Add specfact.com, specfact.io, specfact.dev links prominently at top - Add domain purpose context (commercial, ecosystem, developer community) - Highlight specfact.dev for developers - Add GitHub Pages docs link - Improve user navigation to appropriate resources * docs: update Quick Start with correct IDE setup workflow - Add Step 2: Initialize IDE integration (specfact init --ide) - Update Step 3: Use slash commands in IDE or CLI - Add realistic timing expectations (10-15 min for typical repos) - Explain what init does (copies prompts, makes slash commands available) - Add link to AI IDE Workflow Guide - Remove unrealistic '60 seconds' claim * fix: correct heading level for SpecFact Domains section * docs: fix GitHub Pages permalinks for all documentation pages - Update permalinks to include full directory path (e.g., /reference/commands/ instead of /commands/) - Add frontmatter with permalinks to agile-scrum-workflows.md and reference/README.md - Add frontmatter with permalink to speckit-journey.md for consistency - All permalinks now match the Jekyll configuration pattern - Enables proper GitHub Pages URLs for platform-frontend sites * fix: resolve Jekyll build errors for GitHub Pages - Quote title in speckit-journey.md frontmatter to fix YAML parsing error - Wrap Jinja2 template code in {% raw %} tags in agile-scrum-workflows.md to prevent Jekyll from parsing it as Liquid syntax Fixes GitHub Pages build errors: - YAML Exception in speckit-journey.md (line 3) - Liquid syntax error in agile-scrum-workflows.md (line 708) * docs: add new pages to GitHub Pages navigation menu - Add Command Chains to Guides section - Add Agile/Scrum Workflows to Guides section - Add Reference Documentation index to Reference section These pages were missing from the navigation menu after fixing permalinks. * docs: add new pages to GitHub Pages sidebar navigation menu - Add Command Chains to Guides section (top of list) - Add Agile/Scrum Workflows to Guides section - Add Reference Documentation index to Reference section - Fix reference links to use correct permalinks (/reference/architecture/, etc.) The sidebar navigation menu is hardcoded in the layout file, so these pages need to be manually added to appear in the left sidebar. * feat: add Mermaid.js support for diagram rendering on GitHub Pages - Add Mermaid.js CDN script to layout - Add JavaScript to convert mermaid code blocks to renderable divs - Handle kramdown output format (pre > code.language-mermaid) - Initialize Mermaid with proper configuration Fixes Mermaid diagram rendering on GitHub Pages documentation. All mermaid code blocks will now render as interactive diagrams. * feat: align GitHub Pages styling with specfact.io design - Update color scheme to match specfact.io (dark theme with cyan accent) - Change primary colors: #64ffda (cyan), #0a192f (dark blue), #112240 (light dark) - Update Mermaid theme to dark with custom colors matching specfact.io - Add Inter and JetBrains Mono fonts to match specfact.io typography - Add Mermaid-specific CSS styling for better diagram appearance - Remove light mode support, use dark theme consistently Colors now match specfact.io: - Primary/Highlight: #64ffda (cyan) - Background: #0a192f (dark blue) - Text: #ccd6f6 (light blue-gray) - Code background: #1d2d50 (darker blue) Mermaid diagrams now use dark theme with cyan accents for better readability and visual consistency with specfact.io documentation site. * fix: improve YAML and code syntax highlighting for dark theme - Update Rouge syntax highlighting colors for dark theme readability - Use cyan (#64ffda) for literals, numbers, and constants - Use light green (#a8e6cf) for strings (better contrast on dark) - Use pink (#ff6b9d) for keywords and operators - Use purple (#c792ea) for functions and classes - Use yellow (#ffd93d) for variables - Use muted gray-blue (#8892b0) for comments - YAML keys now use cyan color for better visibility Fixes readability issues with YAML and other code blocks on dark background. * feat: update to custom domain docs.specfact.io - Update _config.yml: set baseurl to empty string for custom domain - Update _config.yml: set url to https://docs.specfact.io - Exclude assets/ from default permalink pattern to fix CSS path - Update README.md to use new docs.specfact.io domain - Fixes CSS 404 errors on custom domain * docs: add CNAME file for GitHub Pages custom domain Required for GitHub Pages to recognize docs.specfact.io as custom domain. This file must be in the repository root (not in docs/). --------- Co-authored-by: Dominikus Nold <[email protected]>
1 parent 8b5ee64 commit e3b2c45

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs.specfact.io

0 commit comments

Comments
 (0)