├── CONTRIBUTING.md
├── LICENSE
├── README.md
└── awesome-vitepress-logo.svg
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # How to Contribute
2 |
3 | First of all, thank you for your interests in Awesome VItepress. All kinds of contributions are valuable to making Vitepress more popular! :pray:
4 |
5 | We ask that you kindly follow this simple guideline:
6 | 1. Make sure to add items in the right section or subsection!
7 | 2. To be fair to people before you, please add your items at end.
8 | 3. Feel free to reorganize sections or subsection as appropriate, including adding new ones or editing current ones.
9 | 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.
10 |
11 | Remark: We may revise content or remove unrelated, outdated or no longer supported items.
12 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2023 Logic Spark
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 |
9 | # Awesome VitePress v1 (Beta) [](https://github.com/sindresorhus/awesome)
10 |
11 |
12 | > A curated list of awesome things related to VitePress
13 |
14 | - [Resources](#books-resources)
15 | - [Official Resources](#official-resources)
16 | - [Tutorials](#tutorials)
17 | - [Articles](#articles)
18 | - [Videos](#videos)
19 | - [Related Awesome Lists](#related-awesome-lists)
20 | - [Plugins](#electric_plug-plugins)
21 | - [Official Plugins](#official-plugins)
22 | - [Community Plugins](#community-plugins)
23 | - [Themes](#art-themes)
24 | - [Official Themes](#official-themes)
25 | - [Community Themes](#community-themes)
26 | - [Projects Using VitePress](#card_index_dividers-projects-using-vitepress)
27 | - [VitePress Contributors](#heart-vitepress-contributors)
28 | - [How to Contribute](#pray-how-to-contribute)
29 | - [License](#white_check_mark-license)
30 | - [Acknowledgement](#raise_hands-acknowledgement)
31 |
32 |
33 | ## :books: Resources
34 |
35 | ### Official Resources
36 | - [VitePress Github Repository](https://github.com/vuejs/vitepress)
37 | - Docs - [Getting Started](https://vitepress.dev/guide/getting-started), [Writing](https://vitepress.dev/guide/markdown), [Customization](https://vitepress.dev/guide/custom-theme), [Configuration](https://vitepress.dev/reference/site-config)
38 |
39 | ### Tutorials
40 |
41 | > #### Articles
42 | - [How to Build a Modern Documentation Site with VitePress](https://www.freecodecamp.org/news/how-to-build-a-modern-documentation-site-with-vitepress/)
43 | - [Write Beautiful Documentation Quickly with VitePress](https://learnvue.co/articles/write-docs-with-vitepress)
44 | - Create a Blog with Vitepress
45 | - [Part 1 - Create a Blog with Vitepress](https://medium.com/@jeremy3/create-a-blog-with-vitepress-c4b1c203d688)
46 | - [Part 2 - Create components in Vitepress using Tailwind](https://medium.com/@jeremy3/create-components-in-vitepress-using-tailwind-a4eee4b4ec41)
47 | - [Build a blog with Vitepress and Vue.js](https://blog.logrocket.com/build-blog-vitepress-vue-js/)
48 |
49 | > #### Videos
50 | - [VitePress The New Vite Static Site Generator Tutorial by Erik](https://www.youtube.com/watch?v=y9jKmNPmfPE)
51 | 1. [2:33](https://www.youtube.com/watch?v=y9jKmNPmfPE&t=153s) VitePress Introduction
52 | 2. [4:33](https://www.youtube.com/watch?v=y9jKmNPmfPE&t=273s) Updating the Configuration
53 | 3. [6:37](https://www.youtube.com/watch?v=y9jKmNPmfPE&t=397s) Updating Themes with Vue 3
54 | - [Easy Documentation with VitePress by LearnVue](https://www.youtube.com/watch?v=jRBQpjmwH1c)
55 | 1. [0:15](https://www.youtube.com/watch?v=jRBQpjmwH1c&t=15s) Advantages of VitePress
56 | 2. [1:06](https://www.youtube.com/watch?v=jRBQpjmwH1c&t=66s) Getting Started
57 | 3. [3:00](https://www.youtube.com/watch?v=jRBQpjmwH1c&t=180s) Routes & Links
58 | 4. [6:05](https://www.youtube.com/watch?v=jRBQpjmwH1c&t=375s) Built-In Markdown
59 | - [Deep dive into VitePress by Kia King Ishii](https://www.youtube.com/watch?v=GXr8FOssWqM)
60 | 1. [1:40](https://www.youtube.com/watch?v=GXr8FOssWqM&t=100s) What is VitePress
61 | 2. [4:10](https://www.youtube.com/watch?v=GXr8FOssWqM&t=250s) Basic Configuarion
62 | 3. [7:15](https://www.youtube.com/watch?v=GXr8FOssWqM&t=435s) How VitePress works
63 | 4. [9:25](https://www.youtube.com/watch?v=GXr8FOssWqM&t=565s) Core Components
64 | 5. [14:50](https://www.youtube.com/watch?v=GXr8FOssWqM&t=890s) VitePress Plugin
65 | 6. [23:25](https://www.youtube.com/watch?v=GXr8FOssWqM&t=1405s) VitePress Client Side
66 |
67 | ### Related Awesome List
68 | - [Vue 3](https://github.com/vuesomedev/awesome-vue-3)
69 | - [Vite](https://github.com/vitejs/awesome-vite)
70 | - [VuePress 2](https://github.com/vuepress/awesome-vuepress/blob/main/v2.md)
71 |
72 | ## :electric_plug: Plugins
73 |
74 | ### Official Plugins
75 | > Pending for official plugins
76 |
77 | ### Community Plugins
78 | - [PWA](https://github.com/vite-pwa/vitepress) - Zero-config PWA Plugin for VitePress
79 | - [Comment with Giscus](https://github.com/T-miracle/vitepress-plugin-comment-with-giscus) - vitepress comment plugin based on [Giscus](https://giscus.app/)
80 | - [Google Analytics](https://github.com/ZhongxuYang/vitepress-plugin-google-analytics/) - Google Analytics Plugin for VitePress
81 | - [Local Search with Flexsearch](https://github.com/emersonbottero/vitepress-plugin-search) - Local search to your documentation site using [Flexsearch](https://github.com/nextapps-de/flexsearch)
82 | - [Diagramming and Charting with Mermaid](https://github.com/emersonbottero/vitepress-plugin-mermaid) - Diagramming and charting tool using [Mermaid](https://mermaid.js.org/)
83 | - Sidebar
84 | - [vitepress-sidebar](https://github.com/jooy2/vitepress-sidebar) - Automatically configures and manages the sidebar of your page with simple settings
85 | - [vitepress-plugin-autobar](https://github.com/luciozhang/vitepress-plugin-autobar) - Generator sidebar based on file and directory structure
86 | - [vite-plugin-vitepress-auto-sidebar](https://github.com/QC2168/vite-plugin-vitepress-auto-sidebar) - Automatically generates sidebar data by scanning directories
87 | - [vitepress-sidebar-builder](https://github.com/stuyk/vitepress-sidebar-builder) - A recursive sidebar builder
88 | - [vitepress-plugin-auto-sidebar](https://github.com/JonathanSchndr/vitepress-plugin-auto-sidebar) - Generate the sidebar through the folder structure
89 | - [Progress Bar with NProgress](https://github.com/ZhongxuYang/vitepress-plugin-nprogress/) - Display slim progress bar like on YouTube, Medium, etc with [NProgress](https://github.com/rstacruz/nprogress)
90 | - [Static Code Samples with Twoslash](https://github.com/wagmi-dev/vitepress-plugin-shiki-twoslash) - Display code samples on markdown using [Shiki Twoslash](https://github.com/shikijs/twoslash)
91 | - [Timeline for Markdown](https://github.com/HanochMa/vitepress-markdown-timeline) - Display vertical timeline in Markdown
92 | - [Live Coding on Browser](https://github.com/jerrywu001/vitepress-plugin-sandpack) - Live coding using [Sandpack](https://github.com/jerrywu001/sandpack-vue3)
93 | - [Collapsable Code Blocks](https://github.com/T-miracle/vitepress-plugin-codeblocks-fold) - Collapse long code blocks in Markdown
94 | - [View Image](https://github.com/T-miracle/vitepress-plugin-image-viewer) - Image viewer base on [Viewer.js](https://github.com/fengyuanchen/viewerjs)
95 | - [Zip Build Folder](https://github.com/manchan4869/vitepress-plugin-compression) - Automatically package the build output folder using 7za.exe
96 | - [Export to PDF](https://github.com/condorheroblog/vitepress-export-pdf) - Allows you to export your sites to a PDF file
97 | - [Preview Demo](https://github.com/flingyp/vitepress-demo-preview) - Preview demo and show source codes
98 | - [Override Default Theme](https://github.com/Dschungelabenteuer/vitepress-plugin-theme-override) - Override parts of Vitepress' default theme without the need to import it all
99 | - [lite-tree](https://github.com/zhangfisher/lite-tree) - Easy to render tree on vitepress
100 | - [vitepress-i18n](https://github.com/jooy2/vitepress-i18n) - VitePress i18n is a plugin for VitePress that makes it easy to translate text in the default theme and search tool
101 | - [Global Announcement](https://github.com/ATQQ/sugar-blog/tree/master/packages/vitepress-plugin-announcement) - Add a global announcement window
102 | - [Code Group Icons](https://github.com/yuyinws/vitepress-plugin-group-icons) - Enhance code blocks features
103 | - [RSS](https://github.com/ATQQ/sugar-blog/tree/master/packages/vitepress-plugin-rss) - Generate RSS feed for your site
104 | - [vitepress-openapi](https://github.com/enzonotario/vitepress-openapi) - Generate VitePress API Documentation from OpenAPI Specification
105 | - [Versioning](https://github.com/IMB11/vitepress-versioning-plugin) - Add versioning support
106 |
107 | ## :art: Themes
108 |
109 | ### Official Themes
110 | - [Default Theme](https://vitepress.dev/reference/default-theme-config)
111 | - [Vue Theme](https://github.com/vuejs/theme) - Dedicated for `vuejs.org` and may defer from the default theme
112 |
113 | ### Community Themes
114 | - [vitepress-theme-demoblock](https://github.com/xinlei3166/vitepress-theme-demoblock) - Based on the original Vitepress theme
115 | - Blog Style
116 | - [sugar-blog](https://github.com/ATQQ/sugar-blog) - A Minimalist, blog style theme
117 | - [vitepress-blog-pure](https://github.com/airene/vitepress-blog-pure) - Minimal vitepress theme for blog
118 | - [vitepress-blog-zaun](https://github.com/clark-cui/vitepress-blog-zaun) - Journal style theme
119 | - [vitepress-theme-sakura](https://github.com/flaribbit/vitepress-theme-sakura) - A cute and animated blog theme for vitepress
120 | - [hexo-theme-linear](https://github.com/yysuen/hexo-theme-linear) - Theme with clean look, blog style
121 | - [vitepress-theme-vuetom](https://github.com/lauset/vitepress-theme-vuetom) - A flat vitepress theme
122 | - [shopware-developer-documentation-vitepress](https://github.com/shopware/developer-documentation-vitepress)
123 | - [hexo-theme-yun](https://github.com/YunYouJun/hexo-theme-yun) - A blog style theme for vitepress
124 | - [vitepress-theme-api](https://github.com/logicspark/vitepress-theme-api) - An API document theme for Vitepress
125 | - [vitepress-theme-carbon](https://github.com/brenoepics/vitepress-carbon) - A GitHub-like theme for Vitepress
126 |
127 |
128 | ## :card_index_dividers: Projects Using VitePress
129 |
130 | ### Official Projects
131 | - [Vue.js Website](https://vuejs.org) - Official Vue documentation at `vuejs.org`
132 |
133 | ### Projects
134 | - [Vite Ruby](https://github.com/ElMassimo/vitepress-theme) - Vite Ruby docs based on the official Vue doc theme
135 | - [StackBlitz Docs](https://github.com/stackblitz/docs) - Documentation for [StackBlitz](https://stackblitz.com/), an online development
136 | - [Genshin Interactive Map](https://github.com/kongying-tavern/docs) - Kongying Tavern Genshin Interactive Map Documentation
137 | environment.
138 | - [ruabick](https://github.com/dewfall123/ruabick) - Dumi like tool
139 | - [Slidev](https://github.com/slidevjs/docs) - Documentation for [Slidev](https://sli.dev/), Presentation Slides for Developers
140 | - [MODX Revolution](https://github.com/modx-pro/Docs) - Open Source documentation for [MODX Revolution](https://modx.pro/)
141 | - [Rollup.js](https://github.com/rollup/rollup-docs-cn) - Documentation for [Rollup](https://rollupjs.org/), The JavaScript module bundler
142 | - [MTGJSON](https://github.com/mtgjson/mtgjson-website) - MTGJSON Documentation
143 | - [Windi CSS](https://github.com/windicss/docs) - Documentation for Windi CSS
144 | - [Omnivore](https://github.com/omnivore-app/docs.omnivore) - Documentation for the [Omnivore](https://omnivore.app/), an open source read-it-later solution
145 | - [Iconify](https://github.com/iconify/website) - Documentation for [Iconify](https://iconify.design/), over 150,000 open source vector icons in one framework
146 | - [Fusion UI](https://github.com/tsinghua-lau/fusion-ui) Documentation for [Fusion UI](https://tsinghua-lau.github.io/fusion-ui/), a Vue 3 component library
147 | - [upscale](https://github.com/Phhofm/upscale) - Website to visually compare the output created with over 600 different AI upscaling models.
148 | - [asdf](https://asdf-vm.com) - Manage multiple runtime versions with a single CLI tool, extendable via plugins.
149 | - [Chromatone.center](https://chromatone.center) - Visual Music Language web-site. Learn music theory with colors and improve your music practice with interactive web-apps.
150 | - [Graffle](https://graffle.js.org) - Simple GraphQL Client for JavaScript. Minimal. Extensible. Type Safe. Runs everywhere.
151 | - [Chukti](https://chukti.vercel.app/) - Low-Code Smart Contract Testing Library: Simple, efficient, and user-friendly with intuitive BDD syntax in plain English.
152 | - [Vue PDF Viewer](https://docs.vue-pdf-viewer.dev/) - Documentation for Vue PDF Viewer, a powerful and flexible PDF Viewer component for Vue.js.
153 |
154 | ### Blogging Websites
155 | - [harlanzw.com-vitepress](https://github.com/harlan-zw/harlanzw.com-vitepress) - Personal [blog](https://harlanzw.com/) built using VitePress and TailwindCSS
156 | - [Charles's personal blog](https://github.com/Charles7c/charles7c.github.io) - Personal technology [blog](https://blog.charles7c.top/)
157 | - [Code More Create](https://blog.merlin218.top/)
158 | - [sugar's personal blog](https://github.com/ATQQ/sugar-blog) - Personal [blog](https://sugarat.top/) and provide VitePress theme [@sugarat/theme](https://github.com/ATQQ/sugar-blog/tree/master/packages/theme)
159 | - [友人 A の博客](https://github.com/NIU-BIN/blog) - Personal [blog](http://niubin.site/)
160 | - [開源旅遊共筆](https://github.com/travel-guide-tw/travel-guide-tw.github.io/) - Open-source travel [blog](https://travel-guide-tw.github.io/), allowing users to access and contribute
161 |
162 | ## :heart: VitePress Top Contributors
163 | [](https://github.com/brc-dd)
164 | [](https://github.com/yyx990803)
165 | [](https://github.com/kiaking)
166 | [](https://github.com/posva)
167 | [](https://github.com/zonemeen)
168 | [](https://github.com/antfu)
169 | [](https://github.com/userquin)
170 | [](https://github.com/CHOYSEN)
171 | [](https://github.com/meteorlxy)
172 | [](https://github.com/patak-dev)
173 | [](https://github.com/kecrily)
174 | [](https://github.com/bencodezen)
175 |
176 | ## :pray: How to Contribute
177 | Thank you for your interests in Awesome VItepress. All kinds of contributions are valuable to making Vitepress more popular!
178 |
179 | We ask that you kindly follow this simple guideline
180 | 1. Make sure to add items in the right section or subsection!
181 | 2. To be fair to people before you, please add your items at the end.
182 | 3. Feel free to reorganize sections or subsection as appropriate, including adding new ones or editing current ones.
183 | 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.
184 |
185 | Remark: We may revise content or remove unrelated, outdated or no longer supported items.
186 |
187 | ## :white_check_mark: License
188 | Distributed under the MIT License. See [`LICENSE`](https://github.com/logicspark/awesome-vitepress-v1/edit/main/LICENSE) for more information.
189 |
190 | ## :raised_hands: Acknowledgement
191 | - [Awesome](https://github.com/sindresorhus/awesome)
192 | - [VitePress](https://github.com/vuejs/vitepress)
193 | - [Vite](https://github.com/vitejs/vite)
194 | - [Awesome-VuePress](https://github.com/vuepress/awesome-vuepress/tree/main)
195 |
--------------------------------------------------------------------------------
/awesome-vitepress-logo.svg:
--------------------------------------------------------------------------------
1 |
64 |
--------------------------------------------------------------------------------
5 |