Project Overview

TechHub is a continuously growing personal tech knowledge base, built with VitePress, where all learning content is written in Markdown and deployed as a static site with one click.

Site Positioning

Aggregating multiple kinds of technical content for one-stop browsing:

Section	Path	Content
Technical Docs	/frontend/ /backend/ /languages/ /ai/	Knowledge notes for each technical domain
Learning Paths	/paths/	Step-by-step learning roadmaps
Process Journals	/journals/	Learning logs, pitfalls and project retrospectives
Book Notes	/books/	Intensive reading notes on books
Literature Collection	/papers/	Paper reading notes
Project Docs	/project/	Documentation for building and maintaining this site

Tech Stack

• Build: VitePress 1.x (Vue 3 + Vite)
• Search: Built-in local full-text search
• Deployment: scripts/deploy.mjs one-click publish to Tencent Cloud COS + CDN (with version backup / rollback / auto-purge)
• Hosting: GitHub 0end1/docs-site

Quick Start

npm install          # Install dependencies
npm run docs:dev     # Local development (http://localhost:5173)
npm run docs:build   # Build the static site (docs/.vitepress/dist)
npm run deploy       # Publish online (requires .env configuration, see Deployment)

Content Guidelines

• Technical docs are archived in the corresponding directories under docs/, one page per topic, each focused on a single subject;
• Each page declares title / description / tags in Frontmatter at the top;
• Learning-record content follows the "Writing Guidelines" template on each domain's homepage;
• After adding a new page, register it in the navigation and sidebar in docs/.vitepress/config.mjs.

Related Documents

• Getting Started — Environment requirements and local development
• Writing Guide — Markdown extended syntax and formatting guidelines
• Deployment — COS + CDN publishing, version rollback and CI/CD
• FAQ — Troubleshooting common issues