https://github.com/rohancyberops/vitepress
✅ Markdown-based content creation 📝 ✅ Lightning-fast HMR for instant updates ⚡ ✅ Vue-powered components for dynamic content 🚀 ✅ Built-in search for easy navigation 🔍 ✅ Customizable themes for a unique look 🎨
https://github.com/rohancyberops/vitepress
Last synced: 6 months ago
JSON representation
✅ Markdown-based content creation 📝 ✅ Lightning-fast HMR for instant updates ⚡ ✅ Vue-powered components for dynamic content 🚀 ✅ Built-in search for easy navigation 🔍 ✅ Customizable themes for a unique look 🎨
- Host: GitHub
- URL: https://github.com/rohancyberops/vitepress
- Owner: RohanCyberOps
- License: mit
- Created: 2025-01-28T12:31:35.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-30T10:54:56.000Z (over 1 year ago)
- Last Synced: 2025-03-10T19:51:30.526Z (over 1 year ago)
- Homepage:
- Size: 23.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
---
# 🚀 **VitePress Documentation Site** 📖
A **modern**, **lightweight**, and **blazing-fast** documentation site built with **VitePress**—a **Vite & Vue-powered** static site generator! ✨
---
## 🌟 **Features**
✅ **📝 Markdown-Centered** – Write docs easily with Markdown
✅ **⚡ Ultra-Fast HMR** – Instant updates while editing
✅ **🎨 Customizable Themes** – Style it your way
✅ **🔍 Built-in Search** – Find content effortlessly
✅ **🚀 Vue-Powered** – Extend functionality with Vue components
---
## 🚀 **Getting Started**
### 📌 **Prerequisites**
Ensure you have:
🔹 **Node.js** (v14 or higher)
🔹 **npm** or **yarn** installed
### ⚙️ **Installation**
```sh
npm install
```
### 🌍 **Start Development Server**
```sh
npm run docs:dev
```
📍 The site will be available at **`http://localhost:5173`**
### 🏗 **Build for Production**
```sh
npm run docs:build
```
### 🔎 **Preview Production Build**
```sh
npm run docs:preview
```
---
## 📂 **Project Structure**
```
.
├── docs/
│ ├── .vitepress/
│ │ └── config.ts # VitePress configuration
│ ├── index.md # Home page
│ └── example.md # Example page
└── package.json
```
---
## ⚡ **Scripts**
| Command | Description |
|----------------|---------------------------------|
| `docs:dev` | Start the development server |
| `docs:build` | Build for production |
| `docs:preview` | Preview the production build |
| `start` | Alias for `docs:dev` |
---
## 📜 **License**
🔹 **MIT License** – Open-source and free to use!
🚀 Get started with **VitePress** today and build **fast, beautiful, and scalable** documentation! 🎉