Skip to content

Commit c6711f8

Browse files
hyperb1isshyperb1iss
committed
📝 Add VitePress documentation site with full setup
Set up comprehensive documentation using VitePress with: - Complete site structure covering guides, variants, design system, extras, and reference documentation - Custom SilkCircuit theme styling with brand colors and neon effects - GitHub Actions workflow for automatic deployment to Pages - Local search integration - Documentation for all 5 theme variants, 40+ plugin integrations, and matching ecosystem themes (VS Code, terminals, CLI tools) - Vendored node_modules for reproducible builds
1 parent 5acdfe4 commit c6711f8

File tree

1,864 files changed

+346554
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,864 files changed

+346554
-0
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- "docs/**"
8+
- ".github/workflows/docs.yml"
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: pages
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
with:
27+
fetch-depth: 0
28+
29+
- name: Setup Node
30+
uses: actions/setup-node@v4
31+
with:
32+
node-version: 20
33+
cache: npm
34+
cache-dependency-path: docs/package-lock.json
35+
36+
- name: Setup Pages
37+
uses: actions/configure-pages@v4
38+
39+
- name: Install dependencies
40+
run: npm ci
41+
working-directory: docs
42+
43+
- name: Build with VitePress
44+
run: npm run docs:build
45+
working-directory: docs
46+
47+
- name: Upload artifact
48+
uses: actions/upload-pages-artifact@v3
49+
with:
50+
path: docs/.vitepress/dist
51+
52+
deploy:
53+
environment:
54+
name: github-pages
55+
url: ${{ steps.deployment.outputs.page_url }}
56+
needs: build
57+
runs-on: ubuntu-latest
58+
steps:
59+
- name: Deploy to GitHub Pages
60+
id: deployment
61+
uses: actions/deploy-pages@v4

‎docs/.vitepress/config.ts‎

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
import { defineConfig } from 'vitepress';
2+
3+
export default defineConfig({
4+
title: 'SilkCircuit',
5+
description: 'Electric Dreams for Neovim - A vibrant theme with neon purples, blazing pinks, and glowing cyan accents',
6+
7+
base: '/silkcircuit-nvim/',
8+
9+
head: [
10+
['link', { rel: 'icon', href: '/silkcircuit-nvim/favicon.svg' }],
11+
['meta', { name: 'theme-color', content: '#e135ff' }],
12+
['meta', { name: 'og:type', content: 'website' }],
13+
['meta', { name: 'og:title', content: 'SilkCircuit - Electric Dreams for Neovim' }],
14+
['meta', { name: 'og:description', content: 'A vibrant Neovim theme with neon purples, blazing pinks, and glowing cyan accents. WCAG AA compliant with 5 variants.' }],
15+
['meta', { name: 'og:image', content: '/silkcircuit-nvim/og-image.png' }],
16+
['meta', { name: 'twitter:card', content: 'summary_large_image' }],
17+
],
18+
19+
themeConfig: {
20+
logo: '/logo.png',
21+
siteTitle: 'SilkCircuit',
22+
23+
nav: [
24+
{ text: 'Guide', link: '/guide/' },
25+
{ text: 'Variants', link: '/variants/' },
26+
{ text: 'Design', link: '/design/' },
27+
{ text: 'Extras', link: '/extras/' },
28+
{ text: 'Reference', link: '/reference/' }
29+
],
30+
31+
sidebar: {
32+
'/guide/': [
33+
{
34+
text: 'Getting Started',
35+
items: [
36+
{ text: 'Introduction', link: '/guide/' },
37+
{ text: 'Installation', link: '/guide/installation' },
38+
{ text: 'Configuration', link: '/guide/configuration' },
39+
{ text: 'Theme Variants', link: '/guide/variants' },
40+
]
41+
}
42+
],
43+
'/variants/': [
44+
{
45+
text: 'Theme Variants',
46+
items: [
47+
{ text: 'Overview', link: '/variants/' },
48+
{ text: 'Neon', link: '/variants/neon' },
49+
{ text: 'Vibrant', link: '/variants/vibrant' },
50+
{ text: 'Soft', link: '/variants/soft' },
51+
{ text: 'Glow', link: '/variants/glow' },
52+
{ text: 'Dawn', link: '/variants/dawn' },
53+
]
54+
}
55+
],
56+
'/design/': [
57+
{
58+
text: 'Design System',
59+
items: [
60+
{ text: 'Overview', link: '/design/' },
61+
{ text: 'Color System', link: '/design/colors' },
62+
{ text: 'Typography', link: '/design/typography' },
63+
{ text: 'Semantic Mapping', link: '/design/semantic' },
64+
]
65+
},
66+
{
67+
text: 'Guidelines',
68+
items: [
69+
{ text: 'Accessibility', link: '/design/accessibility' },
70+
{ text: 'Best Practices', link: '/design/best-practices' },
71+
]
72+
}
73+
],
74+
'/extras/': [
75+
{
76+
text: 'Extras',
77+
items: [
78+
{ text: 'Overview', link: '/extras/' },
79+
]
80+
},
81+
{
82+
text: 'Editors',
83+
items: [
84+
{ text: 'VS Code', link: '/extras/vscode' },
85+
{ text: 'AstroNvim', link: '/extras/astronvim' },
86+
{ text: 'Neovim Plugins', link: '/extras/plugins' },
87+
]
88+
},
89+
{
90+
text: 'Terminals',
91+
items: [
92+
{ text: 'Terminal Themes', link: '/extras/terminals' },
93+
]
94+
},
95+
{
96+
text: 'CLI & Tools',
97+
items: [
98+
{ text: 'btop', link: '/extras/btop' },
99+
{ text: 'K9s', link: '/extras/k9s' },
100+
{ text: 'Git', link: '/extras/git' },
101+
{ text: 'FZF', link: '/extras/fzf' },
102+
]
103+
},
104+
{
105+
text: 'Apps',
106+
items: [
107+
{ text: 'Chrome', link: '/extras/chrome' },
108+
{ text: 'Slack', link: '/extras/slack' },
109+
]
110+
}
111+
],
112+
'/reference/': [
113+
{
114+
text: 'Reference',
115+
items: [
116+
{ text: 'Overview', link: '/reference/' },
117+
{ text: 'Commands', link: '/reference/commands' },
118+
{ text: 'Colors', link: '/reference/colors' },
119+
{ text: 'Highlight Groups', link: '/reference/highlights' },
120+
{ text: 'Health Check', link: '/reference/health' },
121+
]
122+
}
123+
]
124+
},
125+
126+
socialLinks: [
127+
{ icon: 'github', link: 'https://github.com/hyperb1iss/silkcircuit-nvim' }
128+
],
129+
130+
editLink: {
131+
pattern: 'https://github.com/hyperb1iss/silkcircuit-nvim/edit/main/docs/:path',
132+
text: 'Edit this page on GitHub'
133+
},
134+
135+
search: {
136+
provider: 'local'
137+
},
138+
139+
footer: {
140+
message: 'Released under the MIT License.',
141+
copyright: 'Copyright © 2024 Stefanie Jane'
142+
}
143+
},
144+
145+
markdown: {
146+
theme: {
147+
light: 'github-light',
148+
dark: 'one-dark-pro'
149+
},
150+
lineNumbers: true
151+
}
152+
});

‎docs/.vitepress/theme/index.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
import DefaultTheme from 'vitepress/theme';
2+
import './silkcircuit.css';
3+
4+
export default {
5+
extends: DefaultTheme,
6+
};

0 commit comments

Comments
 (0)