Awesome VitePress v1 (Beta)

A curated list of awesome things related to VitePress

• Resources
  • Official Resources
  • Tutorials
    • Articles
    • Videos
  • Related Awesome Lists
• Plugins
  • Official Plugins
  • Community Plugins
• Themes
  • Official Themes
  • Community Themes
• Projects Using VitePress
• VitePress Contributors
• How to Contribute
• License
• Acknowledgement

📚 Resources

Official Resources

• VitePress Github Repository
• Docs - Getting Started, Writing, Customization, Configuration

Tutorials

Articles

• How to Build a Modern Documentation Site with VitePress
• Write Beautiful Documentation Quickly with VitePress
• Create a Blog with Vitepress
  • Part 1 - Create a Blog with Vitepress
  • Part 2 - Create components in Vitepress using Tailwind
• Build a blog with Vitepress and Vue.js

Videos

• VitePress The New Vite Static Site Generator Tutorial by Erik
  1. 2:33 VitePress Introduction
  2. 4:33 Updating the Configuration
  3. 6:37 Updating Themes with Vue 3
• Easy Documentation with VitePress by LearnVue
  1. 0:15 Advantages of VitePress
  2. 1:06 Getting Started
  3. 3:00 Routes & Links
  4. 6:05 Built-In Markdown
• Deep dive into VitePress by Kia King Ishii
  1. 1:40 What is VitePress
  2. 4:10 Basic Configuarion
  3. 7:15 How VitePress works
  4. 9:25 Core Components
  5. 14:50 VitePress Plugin
  6. 23:25 VitePress Client Side

Related Awesome List

• Vue 3
• Vite
• VuePress 2

🔌 Plugins

Official Plugins

Pending for official plugins

Community Plugins

• PWA - Zero-config PWA Plugin for VitePress
• Comment with Giscus - vitepress comment plugin based on Giscus
• Google Analytics - Google Analytics Plugin for VitePress
• Local Search with Flexsearch - Local search to your documentation site using Flexsearch
• Diagramming and Charting with Mermaid - Diagramming and charting tool using Mermaid
• Sidebar
  • vitepress-sidebar - Automatically configures and manages the sidebar of your page with simple settings
  • vitepress-plugin-autobar - Generator sidebar based on file and directory structure
  • vite-plugin-vitepress-auto-sidebar - Automatically generates sidebar data by scanning directories
  • vitepress-sidebar-builder - A recursive sidebar builder
  • vitepress-plugin-auto-sidebar - Generate the sidebar through the folder structure
• Progress Bar with NProgress - Display slim progress bar like on YouTube, Medium, etc with NProgress
• Static Code Samples with Twoslash - Display code samples on markdown using Shiki Twoslash
• Timeline for Markdown - Display vertical timeline in Markdown
• Live Coding on Browser - Live coding using Sandpack
• Collapsable Code Blocks - Collapse long code blocks in Markdown
• View Image - Image viewer base on Viewer.js
• Zip Build Folder - Automatically package the build output folder using 7za.exe
• Export to PDF - Allows you to export your sites to a PDF file
• Preview Demo - Preview demo and show source codes
• Override Default Theme - Override parts of Vitepress' default theme without the need to import it all

🎨 Themes

Official Themes

• Default Theme
• Vue Theme - Dedicated for vuejs.org and may defer from the default theme

Community Themes

• vitepress-theme-demoblock - Based on the original Vitepress theme
• Blog Style
  • sugar-blog - A Minimalist, blog style theme
  • vitepress-blog-pure - Minimal vitepress theme for blog
  • vitepress-blog-zaun - Journal style theme
  • vitepress-theme-sakura - A cute and animated blog theme for vitepress
• hexo-theme-linear - Theme with clean look, blog style
• vitepress-theme-vuetom - A flat vitepress theme
• shopware-developer-documentation-vitepress
• hexo-theme-yun - A blog style theme for vitepress
• vitepress-theme-api - An API document theme for Vitepress

🗂️ Projects Using VitePress

Official Projects

• Vue.js Website - Official Vue documentation at vuejs.org

Projects

• Vite Ruby - Vite Ruby docs based on the official Vue doc theme
• StackBlitz Docs - Documentation for StackBlitz, an online development
• Genshin Interactive Map - Kongying Tavern Genshin Interactive Map Documentation environment.
• ruabick - Dumi like tool
• Slidev - Documentation for Slidev, Presentation Slides for Developers
• MODX Revolution - Open Source documentation for MODX Revolution
• Rollup.js - Documentation for Rollup, The JavaScript module bundler
• MTGJSON - MTGJSON Documentation
• Windi CSS - Documentation for Windi CSS
• Omnivore - Documentation for the Omnivore, an open source read-it-later solution
• Iconify - Documentation for Iconify, over 150,000 open source vector icons in one framework
• Fusion UI Documentation for Fusion UI, a Vue 3 component library
• upscale - Website to visually compare the output created with over 600 different AI upscaling models.
• asdf - Manage multiple runtime versions with a single CLI tool, extendable via plugins.

Blogging Websites

• harlanzw.com-vitepress - Personal blog built using VitePress and TailwindCSS
• Charles's personal blog - Personal technology blog
• Code More Create

❤️ VitePress Top Contributors

🙏 How to Contribute

Thank you for your interests in Awesome VItepress. All kinds of contributions are valuable to making Vitepress more popular!

We ask that you kindly follow this simple guideline

1. Make sure to add items in the right section or subsection!
2. To be fair to people before you, please add your items at end.
3. Feel free to reorganize sections or subsection as appropriate, including adding new ones or editing current ones.
4. If you could, please provide details or documentation links to each item. Please do not add items that are invalid, public archive or not functioning.

Remark: We may revise content or remove unrelated, outdated or no longer supported items.

✅ License

Distributed under the MIT License. See LICENSE for more information.

🙌 Acknowledgement

• Awesome
• VitePress
• Vite
• Awesome-VuePress