Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 76 additions & 0 deletions .github/workflows/docs-site.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Docs Site

on:
push:
branches: [main]
paths:
- 'docs/**'
pull_request:
paths:
- 'docs/**'
workflow_dispatch:

concurrency:
group: docs-site-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

jobs:
build_and_deploy:
if: github.event_name != 'pull_request'
runs-on: ubuntu-latest
name: Build and deploy docs site
permissions:
contents: read
steps:
- uses: actions/checkout@v4
with:
# Full history so VitePress lastUpdated timestamps are accurate
fetch-depth: 0

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
cache-dependency-path: docs/package-lock.json

- name: Install dependencies
working-directory: docs
run: npm ci

- name: Build VitePress site
working-directory: docs
run: npx vitepress build .

- name: Deploy to Azure Static Web Apps
uses: Azure/static-web-apps-deploy@v1
with:
azure_static_web_apps_api_token: ${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN_DOCS }}
repo_token: ${{ secrets.GITHUB_TOKEN }}
action: upload
app_location: 'docs/.vitepress/dist'
skip_app_build: true

build_check:
if: github.event_name == 'pull_request'
runs-on: ubuntu-latest
name: Build check (docs site)
permissions:
contents: read
steps:
- uses: actions/checkout@v4

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
cache-dependency-path: docs/package-lock.json

- name: Install dependencies
working-directory: docs
run: npm ci

- name: Build VitePress site
working-directory: docs
run: npx vitepress build .
3 changes: 3 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules
.vitepress/dist
.vitepress/cache
112 changes: 112 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
import { defineConfig } from 'vitepress'

export default defineConfig({
title: 'Stability Matrix Docs',
description: 'Documentation for Stability Matrix, a multi-platform package manager for Stable Diffusion and related AI tools.',

// Keep README.md as the single source of truth for the home page content,
// while serving it at the site root (index.html) instead of /README.html.
rewrites: {
'README.md': 'index.md'
},

// Dead-link checking stays ON (default) so a future PR that breaks a
// relative link fails the build instead of shipping silently.
ignoreDeadLinks: false,

appearance: 'dark',

// Requires full git history at build time (fetch-depth: 0 in the deploy job).
lastUpdated: true,

sitemap: {
hostname: 'https://docs.lykos.ai'
},

themeConfig: {
outline: 'deep',

search: {
provider: 'local'
},

editLink: {
pattern: 'https://github.com/LykosAI/StabilityMatrix/edit/main/docs/:path',
text: 'Edit this page on GitHub'
},

nav: [
{ text: 'Home', link: '/' },
{ text: 'Getting Started', link: '/getting-started/overview' },
{ text: 'Package Manager', link: '/package-manager/overview' },
{ text: 'Inference', link: '/inference/overview' },
{ text: 'Advanced', link: '/advanced/overview' },
{ text: 'Tips and Tricks', link: '/tips/overview' },
{ text: 'Troubleshooting', link: '/troubleshooting/common-issues' }
],

sidebar: {
'/getting-started/': [
{
text: 'Getting Started',
items: [
{ text: 'Overview', link: '/getting-started/overview' },
{ text: 'Installation', link: '/getting-started/installation' },
{ text: 'First Launch', link: '/getting-started/first-launch' },
{ text: 'Data Directory', link: '/getting-started/data-directory' }
]
}
],
'/package-manager/': [
{
text: 'Package Manager',
items: [
{ text: 'Overview', link: '/package-manager/overview' },
{ text: 'Supported Packages', link: '/package-manager/supported-packages' },
{ text: 'Installing Packages', link: '/package-manager/installing-packages' }
]
}
],
'/inference/': [
{
text: 'Inference',
items: [
{ text: 'Overview', link: '/inference/overview' }
]
}
],
'/advanced/': [
{
text: 'Advanced',
items: [
{ text: 'Overview', link: '/advanced/overview' },
{ text: 'Hardware Support', link: '/advanced/hardware-support' },
{ text: 'ComfyUI Integration', link: '/advanced/comfyui-integration' },
{ text: 'Environment Variables', link: '/advanced/environment-variables' }
]
}
],
'/tips/': [
{
text: 'Tips and Tricks',
items: [
{ text: 'Overview', link: '/tips/overview' },
{ text: 'Terminology', link: '/tips/terminology' }
]
}
],
'/troubleshooting/': [
{
text: 'Troubleshooting',
items: [
{ text: 'Common Issues', link: '/troubleshooting/common-issues' }
]
}
]
},

socialLinks: [
{ icon: 'github', link: 'https://github.com/LykosAI/StabilityMatrix' }
]
}
})
Loading
Loading