Skip to content

wireweave/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Wireweave Docs

@wireweave/docs

Official documentation site for Wireweave

Live SiteLandingDashboard

Overview

Comprehensive documentation for Wireweave DSL including user guides, API reference, and syntax documentation.

Features

  • User Guides: Step-by-step tutorials for getting started
  • API Reference: Complete API documentation
  • DSL Syntax: Grammar and component reference
  • Multi-language: English, Korean, Japanese support
  • Search: Built-in local search

Tech Stack

Category Technology
Framework VitePress 1.x
Analytics Google Analytics 4
SEO Built-in sitemap generation

Documentation Structure

guide/
├── what-is-wireweave.md   # Introduction
├── getting-started.md      # Quick start guide
├── pages.md                # Page structure
├── components.md           # Component usage
├── layouts.md              # Layout system
├── styling.md              # Styling options
├── mcp-server.md           # MCP integration
├── vscode-extension.md     # VS Code setup
└── markdown-plugin.md      # Markdown usage

reference/
├── grammar.md              # DSL grammar specification
├── components.md           # Component reference
└── api.md                  # API documentation

Multi-language Support

Language Path Status
English / Complete
Korean /ko/ Complete
Japanese /ja/ Complete

Development

# Install dependencies
pnpm install

# Start dev server (http://localhost:3304)
pnpm dev

# Build for production
pnpm build

# Preview production build
pnpm preview

Project Structure

.vitepress/
├── config.ts           # VitePress configuration
├── theme/              # Custom theme
│   ├── index.ts
│   └── HomeShowcase.vue
└── wireframe.tmLanguage.json  # Syntax highlighting
guide/                  # English guides
reference/              # English reference
ko/                     # Korean translations
├── guide/
└── reference/
ja/                     # Japanese translations
├── guide/
└── reference/
public/                 # Static assets
├── logo.svg
└── robots.txt
index.md                # Home page

SEO Features

  • Sitemap: Auto-generated at build time
  • robots.txt: AI crawler friendly
  • Open Graph: OG meta tags for social sharing
  • Twitter Card: Twitter card support

Deployment

Links

License

MIT

About

Wireweave documentation - VitePress

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors