Lightning‑fast, versioned documentation for your project – powered by React 19, MDX, Vite SSG, Tailwind, and automatic GitHub Pages subfolder detection. Drop in MDX → get routes, search, version switcher, SEO, and pre-rendered HTML. Zero yak shaving.
| Need | You Get |
|---|---|
| Instant setup | Auto route + search + sitemap generation |
| GitHub Pages quirks | Smart base path resolver (forks, custom domains) |
| Versioned docs | Folder snapshots + version switcher + archived noindex |
| Production SEO | Canonicals, OG/Twitter, JSON‑LD, pre-rendered HTML |
| Great DX | Type‑safe config, enforced aliases, strict frontmatter schema |
| Speed | Vite SSG, code‑splitting, tiny runtime hydration |
Peek at the live docs: https://taurgis.github.io/luma-docs/
npx degit taurgis/luma-docs my-docs
cd my-docs
npm install
npm run devAdd a page (routes appear automatically):
content/pages/getting-started/overview.mdx
Create .github/workflows/deploy.yml (native GitHub Pages):
name: Docs
on: { push: { branches: [main] } }
permissions:
contents: read
pages: write
id-token: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Derive SITE_URL
id: site
run: |
if [ -f CNAME ]; then echo "site_url=https://$(head -n1 CNAME)" >> $GITHUB_OUTPUT; \
else echo "site_url=https://${GITHUB_REPOSITORY_OWNER}.github.io" >> $GITHUB_OUTPUT; fi
- uses: actions/setup-node@v4
with: { node-version: 20, cache: npm }
- run: npm ci --prefer-offline --no-audit
- run: npm run build
env:
SITE_URL: ${{ steps.site.outputs.site_url }}
GITHUB_REPOSITORY: ${{ github.repository }}
- uses: actions/upload-pages-artifact@v3
with: { path: dist }
deploy:
if: github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-latest
environment: { name: github-pages, url: ${{ steps.deployment.outputs.page_url }} }
steps:
- id: deployment
uses: actions/deploy-pages@v4Visit: https://<user>.github.io/<repo>/ (auto base path). Custom domain? Add CNAME → done.
| Script | Purpose |
|---|---|
dev |
Local dev (runs generation once) |
build |
Production static build |
snapshot:version |
Archive current docs → content/versions/<label> |
validate:frontmatter |
Frontmatter schema check |
search-dev / search:generate |
Inspect / rebuild search index |
generate:* |
Manual regeneration (normally not needed) |
test |
Vitest (unit + a11y + SEO) |
Force a subfolder (rarely needed):
# Force subfolder during dev
VITE_FORCE_BASE=/your-repo/ npm run dev
# Force subfolder during build
VITE_FORCE_BASE=/your-repo/ npm run build
# Root deployment (custom domain or username.github.io)
VITE_FORCE_BASE=/ npm run buildYou can use standard Markdown syntax and React components.
---
title: Getting Started
description: How to integrate Luma Docs
order: 1
---Set only what you need—meta + structured data are auto‑rendered.
---
title: "Your Page Title"
description: "Your page description for search engines"
keywords: "keyword1, keyword2, keyword3"
ogType: "article" # or "website"
twitterCard: "summary_large_image" # or "summary"
twitterCreator: "@yourusername"
twitterSite: "@yoursite"
author: "Author Name"
publishedTime: "2024-01-01T00:00:00Z"
modifiedTime: "2024-01-15T10:00:00Z"
section: "Your Section"
tags: ["tag1", "tag2", "tag3"] # Array or comma-separated string
canonical: "/your-canonical-url/"
robots: "index, follow" # or use noindex: true
order: 1
---More in
content/pages/seo-examples.mdx.
-
Basic Meta Tags:
title- Page title (used in<title>and Open Graph)description- 8809 Meta description for search engineskeywords- Comma-separated keywordsauthor- Content authorcanonical- Canonical URL for the pagerobots- Robots directive (or usenoindex: true)
-
Open Graph Meta Tags:
ogType- "website" or "article"ogImage- URL to Open Graph image (1200x630px recommended)
-
Twitter Card Meta Tags:
twitterCard- "summary" or "summary_large_image"twitterCreator- Twitter handle of content creatortwitterSite- Twitter handle of website
-
Article-Specific Meta Tags:
publishedTime- ISO 8601 publication datemodifiedTime- ISO 8601 modification datesection- Article section/categorytags- Array of tags (can also be comma-separated string)
Drop an <SEO /> component inside an MDX file to override frontmatter per section:
# Your Page Content
<SEO
title="Custom Page Title Override"
description="This description will override the frontmatter description"
keywords="custom, override, seo"
ogType="article"
twitterCard="summary"
/>
More content here...Great for dynamic sections or demos.
Meta tags, OG/Twitter, JSON‑LD (Article + Breadcrumbs), canonical URLs, sitemap inclusion, archived pages auto noindex.
Folder + file naming drives sidebar. index.mdx files become the folder landing page. Single‑page groups are flattened. Versioned snapshots preserve historical structure.
Import from the single barrel:
import {
Callout,
CodeBlock,
Collapsible,
CodeTabs,
PageTitle,
PageSubtitle,
} from "@/components"; // Uses the @ -> src aliasAdvanced syntax highlighting with copy functionality:
<CodeBlock
code={`function hello() { console.log("Hello World!"); }`}
language="javascript"
title="Hello World Example"
showLineNumbers={true}
/>Display code examples in multiple languages:
<CodeTabs
tabs={[
{ label: "JavaScript", language: "js", code: "const x = 1;" },
{ label: "TypeScript", language: "ts", code: "const x: number = 1;" },
]}
groupId="example"
/>Use <Code>text</Code> for inline code or <Kbd>Ctrl</Kbd> for keyboard shortcuts.
Highlight important information with semantic styling:
<Callout type="info" title="Information">
This is an informational callout.
</Callout>
<Callout type="warning" title="Warning">
This alerts users to potential issues.
</Callout>
<Callout type="success" title="Success">
Confirms successful operations.
</Callout>
<Callout type="danger" title="Important">
Critical information that must not be ignored.
</Callout>
<Callout type="tip" title="Pro Tip">
Helpful advice and best practices.
</Callout>Organize content in expandable sections:
<Collapsible title="Advanced Configuration" intent="info" defaultOpen>
Content that can be collapsed to save space.
</Collapsible>Enhanced typography with consistent styling:
<PageTitle>Main Page Title</PageTitle>
<PageSubtitle>Descriptive subtitle</PageSubtitle>
<H2>Section Header</H2>
<H3>Subsection Header</H3>
<Lead>Lead paragraph text</Lead>
<Body>Regular body text</Body>- TypeScript Support: All components are fully typed
- Accessibility: Built with ARIA attributes and keyboard navigation
- Responsive Design: Works perfectly on all device sizes
- Consistent Styling: Follows design system patterns
- Performance Optimized: Dynamic imports and code splitting
- Dark Mode Ready: Prepared for future dark mode support
For a complete showcase of all components with live examples, visit the Component Showcase page.
npm run dev– Start development server (runs pipeline once, then launches SSG dev)npm run dev:subfolder– Convenience dev with forced base path (usesVITE_FORCE_BASE=/luma-docs/)npm run build– Full production build (multi-step pipeline + static generation)npm run test– Run Vitest test suite (unit, integration, a11y, SEO tests)npm run clean– Remove build/cache artifactsnpm run lint/npm run lint:fix– ESLint checks and autofixnpm run type-check– TypeScript type checking (runs a minimal pipeline first to ensure generated artifacts exist)npm run snapshot:version– Snapshot current root docs into an archived version (see versioning section)npm run validate:frontmatter– Validate MDX frontmatter against schemanpm run search-dev– Interactive search dev utilitynpm run search:generate(script alias) – Force regeneration of search indexnpm run search:validate(script alias) – Validate existing index
npm run generate:versions– Regeneratesrc/generated-versions.ts(normally auto via pipeline)npm run generate:routes– Regeneratesrc/generated-routes.tsx+ meta (auto in pipeline)npm run generate:search-index– Rebuild local search index (auto in pipeline)npm run generate:sitemap– Regenerate sitemap (auto in pipeline)npm run build:css/npm run build:css:watch– Tailwind CSS one-off or watch buildnpm run pipeline:dev/npm run pipeline:build– Run internal build pipeline only (rarely needed directly)
Environment-based overrides:
- Subfolder dev:
VITE_FORCE_BASE=/your-repo/ npm run dev - Subfolder build:
VITE_FORCE_BASE=/your-repo/ npm run build
Base path detection (root vs subfolder like /luma-docs/) is centralized in src/tools/resolve-base-path.mjs and consumed directly by vite.config.ts, build tooling, runtime helpers, and the sitemap generator.
Resolution priority (first match wins):
VITE_FORCE_BASE– explicit override (e.g./docs/or/preview/)VITE_BASE_PATH– externally provided resolved baseGITHUB_REPOSITORY– if repository ends with.github.io=> root/; else/<repo>/- Git remote
origin– same logic as above (local dev convenience) - Fallback
/
All returned values are normalized to begin with / and (if not root) end with /.
Runtime: getBasePath() (in src/utils/basePath.ts) simply returns the build-time value; createPath() prefixes internal links safely.
Sitemap: generate-sitemap.js uses the same resolver and expects SITE_URL to be the domain only (without the subfolder). If you mistakenly include the subfolder, it will de‑duplicate.
Resolver picks the right base automatically (repo name, custom domain, or forced override). Rarely think about it again.
Configured in tsconfig.json and vite.config.ts:
| Alias | Resolves To |
|---|---|
@ |
src/ |
@/components/* |
src/components/* |
@/utils/* |
src/utils/* |
@/tools/* |
src/tools/* |
@/types |
src/types/index.ts |
@/types/* |
src/types/* |
@/config |
config.ts |
Additional (Vite-only) helper alias: @tools → src/tools.
Enforced by ESLint:
- Deep relative traversals into these folders (e.g.
../../components/...) are disallowed. - MDX files are restricted from using relative imports (
./or../) and must use aliases (ensures examples are copy‑paste stable after refactors).
Generated files under src/generated-*
83BF
.ts* should never be manually edited—always regenerate via the relevant generate:* script.
Key enforced rules:
import/orderwith grouping & alphabetization- Alias preference: custom
no-restricted-importspatterns - MDX-specific relaxed rules (allow implicit component usage, disable unused var noise) + alias enforcement
- Accessibility (
jsx-a11y/*) tuned for docs context
If you add a new top-level directory under src/ that should have an alias, update:
tsconfig.json->compilerOptions.pathsvite.config.ts->resolve.alias- ESLint restrictions (if you want to forbid deep relative access)
- This README +
AGENTS.MD
Luma Docs supports a folder‑based versioning strategy:
content/
pages/ # Current (stable) documentation (label = config.versions.current)
versions/
v0.9/ # Archived version folder (example)
v0.8/
Current docs live in content/pages/. Snapshot with npm run snapshot:version -- v1.2 → archived under content/versions/v1.2/ (auto noindex + version switcher). Missing path on switch? We fall back gracefully. Search can scope current vs all.
Configuration (config.ts):
versions: {
current: "v1.0", // Label applied to root pages
enableSwitcher: true, // Show version switcher when archived exist
strategy: 'folder', // Folder strategy (default / only option currently)
hidden: [], // Versions to exclude from UI switcher
order: [], // Explicit ordering (otherwise semver desc)
}Create snapshot:
Automated helper (preferred):
# Archive current content as v1.0
npm run snapshot:version -- v1.0
# Archive current as v1.0 and immediately bump current label to v1.1
npm run snapshot:version -- v1.0 --bump v1.1Manual (custom filtering):
# 1. Decide new version label (e.g. v1.0 -> archive, start v1.1 in root)
NEW_VER=v1.0
mkdir -p content/versions/$NEW_VER
rsync -a content/pages/ content/versions/$NEW_VER/
# 2. (Optional) Prepend titles to make context explicit in archived MDX
sed -i '' '1s/^/---\ntitle: "Legacy Home ('"$NEW_VER"')"\n---\n/' content/versions/$NEW_VER/index.mdx
# 3. Update config.ts current label if bumping current
vim config.ts
# 4. Regenerate artifacts
npm run generate:routes && npm run generate:search-indexArchived pages: automatic noindex (override with noindex: false). Add canonical if pointing to newer doc.
An automated helper script is included to streamline the snapshot workflow above.
Usage examples:
# Snapshot current root content into versions/v1.0
npm run snapshot:version -- v1.0
# Snapshot and simultaneously bump the current version label to v1.1
npm run snapshot:version -- v1.0 --bump v1.1What it does:
- Validates the target label (must match vMAJOR[.MINOR[.PATCH]])
- Copies all content from
content/pages/intocontent/versions/<label>/ - Regenerates
src/generated-versions.ts - If
--bump <nextLabel>provided: updatesconfig.tsversions.currentand regenerates routes
Typical release flow:
# Finish work for v1.0 in content/pages/
npm run snapshot:version -- v1.0 --bump v1.1
# Now content/pages/ represents v1.1 (current) — edit content freely
git add .
git commit -m "chore: snapshot v1.0 and bump current to v1.1"If you only snapshot (no bump), you can update config.ts later when you begin the next version.
content/
pages/ # Current docs (scanned for routes; labeled as current version)
versions/ # Archived snapshots (auto-detected)
v0.9/
v0.8/
src/
app/ # App shell & layout glue
layout/
Layout.tsx
ErrorBoundary.tsx
components/ # Reusable React + MDX / layout / SEO components
content/
CodeBlock.tsx
CodeTabs.tsx
Collapsible.tsx
MDXPage.tsx
MDXWrapper.tsx
icons.tsx
feedback/
Callout.tsx
layout/
Typography.tsx
VersionBadge.tsx
VersionSwitcher.tsx
navigation/
Sidebar.tsx
OnThisPage.tsx
NextLink.tsx
search/
Search.tsx
seo/
SEO.tsx
Breadcrumbs.tsx
utils/
basePath.ts # Base path helpers
search.ts # Client search helpers
styles/
input.css # Tailwind entry
public/ # Static assets copied to dist (configured via Vite publicDir)
favicon.svg
robots.txt
sitemap.xml
generated-routes.tsx # AUTO-GENERATED: routes w/ version metadata
generated-routes.meta.ts # AUTO-GENERATED: route meta export (frontmatter)
generated-search-index.ts # AUTO-GENERATED: search index data
generated-versions.ts # AUTO-GENERATED: list of archived versions
types/ # Type declarations & ambient defs
src/tools/ # Build & generation scripts (invoked via npm scripts)
generate-routes.js
generate-search-index.js
generate-sitemap.js
generate-versions.js
snapshot-version.js
resolve-base-path.mjs
validate-frontmatter.mjs
run-build-pipeline.mjs
search-dev.js
config.ts # Central site configuration
tailwind.config.js
vite.config.ts
index.html # Vite entry HTML
package.json
dist/ # Build output (ignored in VCS)
The site is optimized for GitHub Pages deployment with intelligent subfolder support. Below is the modern, native GitHub Pages workflow (recommended) followed by legacy / manual options.
Create .github/workflows/deploy.yml using the built‑in Pages deployment actions (no third‑party action needed). The resolver now auto-detects the base path; we only add a tiny step to derive SITE_URL from a CNAME or owner:
name: Docs CI
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: pages-${{ github.ref }}
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Derive SITE_URL (owner.github.io or CNAME)
id: site
run: |
if [ -f CNAME ]; then
DOMAIN=$(head -n1 CNAME | tr -d '\r')
echo "site_url=https://$DOMAIN" >> "$GITHUB_OUTPUT"
else
echo "site_url=https://${GITHUB_REPOSITORY_OWNER}.github.io" >> "$GITHUB_OUTPUT"
fi
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
- name: Install dependencies
run: npm ci --prefer-offline --no-audit
- name: Lint & Typecheck
run: |
npm run lint
npm run type-check
- name: Build (auto base detection)
env:
SITE_URL: ${{ steps.site.outputs.site_url }}
GITHUB_REPOSITORY: ${{ github.repository }}
run: npm run build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: dist
deploy:
if: github.ref == 'refs/heads/main'
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy
id: deployment
uses: actions/deploy-pages@v4Key benefits:
- Native Pages flow (fewer permissions, clearer audit trail)
- Automatic cancellation of superseded builds (faster feedback)
- Zero duplication of base path logic (handled centrally in resolver & Vite config)
- Supports custom domains automatically via optional CNAME
# Auto-detect base path (preferred)
npm run build
# Force a specific subfolder (overrides detection)
VITE_FORCE_BASE=/your-repo/ npm run build
# Force root deployment (custom domain or username.github.io)
VITE_FORCE_BASE=/ npm run buildPreviously this project used peaceiris/actions-gh-pages. It still works, but the native workflow above is preferred. If you need the old snippet, view git history prior to the modernization commit.
Live Example: taurgis.github.io/luma-docs
The built site in the dist folder can be deployed to any static hosting service:
- Vercel: Connect your repository and deploy automatically
- Netlify: Drag and drop the
distfolder or connect via Git - AWS S3: Upload the
distfolder contents to an S3 bucket - Firebase Hosting: Use
firebase deployafter building - Any web server: Serve the
distfolder as static files
Base path & sitemap behavior is primarily controlled by the resolver logic. Supported variables (resolution priority shown earlier under "Unified Base Path Handling"):
VITE_FORCE_BASE– Highest precedence explicit override (e.g./preview/)VITE_BASE_PATH– Pre-resolved base path (used ifVITE_FORCE_BASEabsent)GITHUB_REPOSITORY– Enables automatic GitHub Pages base detection in CISITE_URL– Domain only (no trailing slash, no subfolder); used for sitemap & canonical assembly- (Optional/Future)
GEMINI_API_KEY– Reserved for future AI features (currently unused)
Notes:
- Do NOT include the subfolder in
SITE_URL; the generator appends it. BASE_PATHlegacy variable is not used—remove it from any external automation.
The platform automatically scans content/pages/ (current version) and content/versions/<label>/ (archived) and generates static React Router routes:
- File Structure Mapping: Each
.mdxfile becomes a route (with clean slug normalization) - Nested Routing: Folder structure creates nested routes
- Index Files:
index.mdxcollapse to their parent path (e.g.guides/index.mdx->/guides/) - Dynamic Import: MDX files are code-split and lazily imported for performance
- Version Metadata: Each generated route gets a
versionfield (current or archived label)
The multi-step pipeline (implemented in src/tools/run-build-pipeline.mjs) orchestrates all generation steps before Vite SSG runs. Sequence (npm run build):
- Versions Generation (
generate:versions) – Detect archived folders and emitsrc/generated-versions.ts - Route Generation (
generate:routes) – Scan current + archived MDX and emitsrc/generated-routes.tsx& meta (extract frontmatter + SEO) - CSS Build (
build:css) – Compile Tailwind fromsrc/styles/input.cssintosrc/public/index.css - Search Index (
generate:search-index) – Build version-aware search index (src/generated-search-index.ts) - Sitemap Generation (
generate:sitemap) – Producesrc/public/sitemap.xml(base path aware) - Static Site Generation (Vite React SSG) – Emit pre-rendered HTML with meta tags via
components/SEO.tsx
Dev mode (npm run dev) runs the pipeline once, then launches the SSG dev server; individual scripts can be re-run ad hoc if you change raw MDX or config without restarting.
The SEO system works through integrated runtime & build steps:
- Frontmatter Extraction – Route generation script extracts SEO metadata from MDX frontmatter
components/SEO.tsx– Renders meta tags using the SSG<Head>API (no separate HTML template mutation step)- Static Generation – Meta tags & JSON-LD emitted during SSG for fully crawable static HTML
- Dynamic Override – Inline
<SEO>usage in MDX can override frontmatter values for specific pages/sections - Structured Data – Website + Article schema; optional breadcrumb schema via
config.features.structuredDataBreadcrumbs - Canonical URLs – Automatic canonical generation with base path awareness (GitHub Pages subfolder safe)
- Frontmatter Support: Each MDX file can include YAML frontmatter for metadata
- Component Integration: Use React components directly in MDX files
- Automatic Navigation: Sidebar navigation is generated from file structure and frontmatter
- Search Integration: All content is automatically indexed for search functionality
- Code Splitting: Automatic chunking by vendor, MDX, and Prism libraries
- Static Generation: Pre-rendered HTML for fast initial loads
- Optimized Assets: Hashed filenames for optimal caching
- Tree Shaking: Dead code elimination in production builds
The site configuration is centralized in config.ts. Update this file to customize branding, links, SEO defaults and feature flags:
export const config = {
// Site Information
site: {
name: "Your Site Name",
title: "Your Site Title",
description: "Your site description",
version: "1.0.0",
},
// Branding
branding: {
logo: {
text: "Your",
accent: "Site",
},
},
// Links
links: {
github: "https://github.com/your-username/your-repo",
// Add more links as needed
},
// SEO and Metadata Defaults
seo: {
siteName: "Your Site Title",
defaultTitle: "Your Site Title",
defaultDescription: "Your site description",
author: "Your Name",
keywords: ["documentation", "react", "mdx", "typescript", "vite"],
},
// Feature Flags
features: {
search: true,
breadcrumbs: true,
structuredDataBreadcrumbs: true,
},
// Navigation
navigation: {
showVersionBadge: true,
showGitHubLink: true,
},
};The site uses Tailwind CSS for styling. You can customize:
tailwind.config.js- Tailwind configuration and theme customizationsrc/styles/input.css- Custom CSS styles and Tailwind imports- Typography styles using the
@tailwindcss/typographyplugin - Component-specific styles within individual components
You can customize or add new React components:
- Modify existing components in the
components/directory - Create custom MDX components in
components/MDXWrapper.tsx - Add new layout components for different page types
- Extend the search functionality in
components/Search.tsx
vite.config.ts- Vite configuration, base path handling, and build optimizationpackage.json- Dependencies, scripts, and project metadatatsconfig.json- TypeScript configuration- Base path is automatically handled for different deployment environments
- Frontmatter Options: Extend frontmatter schema for additional metadata
- Custom MDX Components: Add reusable components for documentation
- Search Configuration: Modify search indexing behavior
- Navigation Ordering: Use
orderfield in frontmatter to control navigation
- Frontend: React 19 with TypeScript
- Build Tool: Vite with React SSG plugin
- Styling: Tailwind CSS with Typography plugin
- Routing: React Router with static generation
- Content: MDX with frontmatter support
- Code Highlighting: Prism.js
- Development: Fast HMR and optimized builds
Core runtime technologies (see package.json for full, exact versions):
- React 19 + React Router 6
- MDX 3 (
@mdx-js/react+ rollup integration) - Vite 7 +
vite-react-ssgfor static generation - Tailwind CSS 3 (+ Typography plugin)
- Prism.js for syntax highlighting
- gray-matter for frontmatter parsing
Dev & quality stack includes: Vitest (unit/integration/a11y), ESLint (custom rules for MDX + import hygiene), TypeScript strict mode, jest-axe for accessibility assertions, and zod for schema validation.
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes and test thoroughly
- Run type checking:
npm run type-check - Submit a pull request with a clear description
- Follow TypeScript best practices
- Use semantic commit messages
- Test your changes with both local and subfolder builds
- Update documentation when adding new features
The project ships with a comprehensive Vitest-based test suite:
- Unit & helper tests (e.g. base path utilities, route path helpers)
- Generated artifact validation (routes order, search index shape)
- Accessibility tests using
jest-axe(landmarks, layout, semantics) - SEO meta & canonical behavior tests
Run all tests:
npm testAuthoring guidelines:
- Prefer colocated test naming patterns already used in
test/ - Avoid importing heavy SSG/Vite plugins in tests (config auto-simplifies with
process.env.VITEST) - If adding new generated artifacts, add a smoke test that fails loudly when shape changes unexpectedly.
- Routes not generating: Ensure MDX files have proper frontmatter and run
npm run generate:routes - Styles not updating: Run
npm run build:cssor use watch mode during development - GitHub Pages 404: Verify the base path is correctly set in the build process
- Search not working: Check that
npm run generate:search-indexcompleted successfully - Edited generated file overwritten: Regenerate instead of manual edits (
generate:*scripts) - Alias import errors in MDX: MDX files must use aliases (
@/components/...) not relative paths
- Clear cache:
npm run clean - Verify all dependencies:
npm ci - Check Node.js version (18+ required)
This project is open source and available under the MIT License.
If you have questions or need help:
- Check the documentation in the Demo Site
- Open an issue on GitHub
- Contribute improvements back to the project