Skip to content

velonone/VSPEC

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

188 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

VSPEC

The Documentation Scope for AI Era

AI is the gun, VSPEC is the scope. Without VSPEC, AI shoots blind; with VSPEC, every shot hits the target.

React TypeScript Vite Tailwind License


Obsidian (Local-first) + GitBook (Publishing) + AI (Automation)

Live Demo  ·  Documentation  ·  Pricing


Why VSPEC?

Knowledge workers spend 9.3 hours per week on documentation. VSPEC cuts that in half with AI-powered automation that delivers 20x ROI at $0.40/day.

Problem VSPEC Solution
Manual proofreading takes hours One-click Fix - AI corrects grammar, style, and structure instantly
Processing 100+ docs is impossible Batch Processing - Drag a folder, process everything automatically
Inconsistent terminology across docs Terminology Engine - Maintains professional consistency throughout
Docs in one language limits reach 7 Languages - CN, EN, JP, KR, FR, DE, ES with native-quality output
No visibility into doc quality Structure Analysis - Auto-generated structure graphs and quality scores

Core Features

AI Document Intelligence

  • One-click fix: grammar, style, structure, and flow optimization
  • Batch processing for bulk document operations
  • Real-time AI suggestions as you write
  • Automatic structure analysis and visualization

Editor & Publishing

  • GitBook-style distraction-free editor with markdown support
  • Command palette (Cmd+K) - reach any feature in 2 keystrokes
  • One-click publishing to yourname.vspec.pub
  • Export to PDF, DOCX, HTML, Markdown, and JSON

Collaboration

  • Real-time multi-user editing with live cursors
  • Comments, annotations, and approval workflows
  • Role-based access control (Owner / Editor / Commenter / Viewer)
  • Team workspaces with project isolation

Platform

  • VDID decentralized identity authentication
  • Eye-care theme system (Light / Sepia / Soft Dark)
  • Fully responsive: desktop, tablet, and mobile
  • PWA support for offline access
  • GitHub / GitLab integration for docs-as-code

Ecosystem

VSPEC is part of the Velon product ecosystem:

Product Description Link
VELON Ecosystem hub velon.one
VDID Decentralized identity vdid.io
VWORK Workspace platform velon.work
RTPX Real-time protocol exchange rtpx.io
VELGOO Discovery engine velgoo.cc
VSPEC Documentation OS vspec.pub

Tech Stack

Layer Technology
Framework React 18 + TypeScript
Build Vite 6 with esbuild
Styling Tailwind CSS v4 + Emotion
Routing React Router v7
State Zustand + Immer
UI Components Radix UI + Material UI
Rich Editor Tiptap 3
Animation Motion (Framer Motion)
AI Backend Multi-model (cost-optimized token routing)
Auth Supabase + VDID OAuth 2.0
i18n i18next

Quick Start

# Clone repository
git clone https://github.com/Vleonone/VSPEC.git
cd VSPEC

# Install dependencies
pnpm install

# Start development server
pnpm dev

Open http://localhost:5173 in your browser.

# Build for production
pnpm build

# Preview production build
pnpm preview

# Run tests
pnpm test

Project Structure

VSPEC/
├── docs/                    # Markdown documentation (auto-synced to /docs page)
│   ├── guides/              # Quick start & usage guides
│   ├── internal/            # Internal strategy & planning docs
│   └── *.md                 # Architecture, specs, whitepapers
├── src/
│   ├── app/
│   │   ├── components/      # Reusable UI components
│   │   ├── hooks/           # Custom React hooks
│   │   ├── pages/           # Page components (lazy-loaded)
│   │   ├── stores/          # Zustand state stores
│   │   └── utils/           # Utilities & helpers
│   ├── lib/                 # API clients, auth, storage
│   └── assets/              # Static assets
├── public/                  # Public assets & PWA manifest
└── vite.config.ts           # Vite configuration

Documentation

Full documentation is available at /docs and is automatically generated from the docs/ directory. Key references:

Design System

Token Value Usage
Brand Color #7C85ED Accent, links, interactive elements
Typography Space Grotesk / Inter Headings / Body text
Background #FAFAFA / #0F0F12 Light / Dark mode
Radius 8px / 12px / 16px Buttons / Cards / Modals
Philosophy Restrained & authoritative No gradients, no marketing fluff

Pricing

Personal PRO Team
Price Free $12/mo $8/person/mo
Documents 5 cloud Unlimited Unlimited
AI Analyses 20/day Unlimited Unlimited
One-click Fix - Included Included
Batch Processing - Included Included
Publishing - Custom domain Custom domain
Collaboration - 3 people Unlimited
Export Markdown PDF/DOCX/HTML PDF/DOCX/HTML

License

Proprietary - All rights reserved.


VSPEC - The Documentation Scope for AI Era

Website  ·  Docs  ·  Pricing

About

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages