|
12 | 12 | - [Awesome VuePress V2 ](#awesome-vuepress-v2-)
|
13 | 13 | - [Resources](#resources)
|
14 | 14 | - [Official Resources](#official-resources)
|
| 15 | + - [Source](#source) |
15 | 16 | - [Tutorials](#tutorials)
|
16 | 17 | - [Examples](#examples)
|
17 | 18 | - [Plugins](#plugins)
|
18 | 19 | - [Official Plugins](#official-plugins)
|
| 20 | + - [Common Features](#common-features) |
| 21 | + - [Search](#search) |
| 22 | + - [Blogging](#blogging) |
| 23 | + - [PWA](#pwa) |
| 24 | + - [SEO](#seo) |
| 25 | + - [Highlighting](#highlighting) |
| 26 | + - [Theme developing](#theme-developing) |
19 | 27 | - [Community Plugins](#community-plugins)
|
20 | 28 | - [Themes](#themes)
|
21 | 29 | - [Official Themes](#official-themes)
|
22 | 30 | - [Community Themes](#community-themes)
|
23 | 31 | - [Projects Using VuePress@v2](#projects-using-vuepressv2)
|
24 |
| - - [Official Projects](#official-projects) |
25 |
| - - [Blogging](#blogging) |
26 | 32 | - [Open Source](#open-source)
|
| 33 | + - [Blogs](#blogs) |
27 | 34 | - [License](#license)
|
28 | 35 |
|
29 | 36 | ## Resources
|
30 | 37 |
|
31 | 38 | ### Official Resources
|
32 | 39 |
|
33 |
| -- [Docs - Official Guide](https://v2.vuepress.vuejs.org/guide/) |
| 40 | +- [Docs - Official Guide](https://v2.vuepress.vuejs.org/guide/getting-started.html) |
34 | 41 | - [Docs - Config Reference](https://v2.vuepress.vuejs.org/reference/config.html)
|
35 |
| -- [Docs - GitHub Repo](https://github.com/vuepress/vuepress-next) |
| 42 | + |
| 43 | +### Source |
| 44 | + |
| 45 | +- [Core Repo](https://github.com/vuepress/core) |
| 46 | +- [Ecosystem Repo](https://github.com/vuepress/ecosystem) |
| 47 | +- [Docs Repo](https://github.com/vuepress/docs) |
36 | 48 |
|
37 | 49 | ### Tutorials
|
38 | 50 |
|
39 |
| -- [A step by step tutorial creating and using VuePress Project](https://theme-hope.vuejs.press/cookbook/tutorial/) ([中文版本](https://theme-hope.vuejs.press/zh/cookbook/tutorial/)) |
| 51 | +- [A step by step tutorial creating and using VuePress Project](https://theme-hope.vuejs.press/get-started/) ([中文版本](https://theme-hope.vuejs.press/zh/get-started/)) |
40 | 52 | - [Markdown Guide](https://theme-hope.vuejs.press/cookbook/markdown/) ([中文版本](https://theme-hope.vuejs.press/zh/cookbook/markdown/))
|
41 | 53 | - [Define variables and use them in markdown](https://stackblitz.com/edit/vuepress-markdown-variable?file=docs%2F.vuepress%2Fconfig.ts,docs%2F.vuepress%2Fclient.ts,docs%2Fguide%2FREADME.md)
|
42 | 54 |
|
|
50 | 62 |
|
51 | 63 | **Maintained by [vuepress](https://github.com/vuepress):**
|
52 | 64 |
|
53 |
| -- [@vuepress/plugin-active-header-links](https://v2.vuepress.vuejs.org/reference/plugin/active-header-links.html): Update route hash when scrolling pages. |
54 |
| -- [@vuepress/plugin-back-to-top](https://v2.vuepress.vuejs.org/reference/plugin/back-to-top.html): Back to top button |
55 |
| -- [@vuepress/plugin-container](https://v2.vuepress.vuejs.org/reference/plugin/container.html): Register markdown custom containers in your VuePress site. |
56 |
| -- [@vuepress/plugin-docsearch](https://v2.vuepress.vuejs.org/reference/plugin/docsearch.html): Integrate [Algolia DocSearch](https://docsearch.algolia.com/) into VuePress |
57 |
| -- [@vuepress/plugin-external-link-icon](https://v2.vuepress.vuejs.org/reference/plugin/external-link-icon.html): Add a icon to the external link in your markdown content |
58 |
| -- [@vuepress/plugin-git](https://v2.vuepress.vuejs.org/reference/plugin/git.html): Collect git information of your pages, including the created and updated time, the contributors, etc. |
59 |
| -- [@vuepress/plugin-google-analytics](https://v2.vuepress.vuejs.org/reference/plugin/google-analytics.html): Integrate [Google Analytics](https://analytics.google.com/) into VuePress. |
60 |
| -- [@vuepress/plugin-medium-zoom](https://v2.vuepress.vuejs.org/reference/plugin/medium-zoom.html): Integrate [medium-zoom](https://github.com/francoischalifour/medium-zoom#readme) into VuePress. |
61 |
| -- [@vuepress/plugin-palette](https://v2.vuepress.vuejs.org/reference/plugin/palette.html): Provide palette support for your theme. |
62 |
| -- [@vuepress/plugin-prismjs](https://v2.vuepress.vuejs.org/reference/plugin/prismjs.html): Enable syntax highlighting for markdown code fence with [Prism.js](https://prismjs.com/) |
63 |
| -- [@vuepress/plugin-pwa-popup](https://v2.vuepress.vuejs.org/reference/plugin/pwa-popup.html): Provide a popup component for users to activate the new PWA service worker manually. |
64 |
| -- [@vuepress/plugin-pwa](https://v2.vuepress.vuejs.org/reference/plugin/pwa.html): Make your VuePress site a [Progressive Web Application (PWA)](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps). |
65 |
| -- [@vuepress/plugin-register-components](https://v2.vuepress.vuejs.org/reference/plugin/register-components.html): Register Vue components from component files or directory automatically. |
66 |
| -- [@vuepress/plugin-search](https://v2.vuepress.vuejs.org/reference/plugin/search.html): Provide local search to your documentation site. |
67 |
| -- [@vuepress/plugin-shiki](https://v2.vuepress.vuejs.org/reference/plugin/shiki.html): Enable syntax highlighting for markdown code fence with [Shiki](https://shiki.matsu.io/) |
68 |
| -- [@vuepress/plugin-theme-data](https://v2.vuepress.vuejs.org/reference/plugin/theme-data.html): Provide client data for your theme, with VuePress I18n support. |
69 |
| -- [@vuepress/plugin-toc](https://v2.vuepress.vuejs.org/reference/plugin/toc.html): Provide a table-of-contents (TOC) component. |
| 65 | +#### Common Features |
| 66 | + |
| 67 | +- [@vuepress/plugin-back-to-top](https://ecosystem.vuejs.press/plugins/back-to-top.html): Back to top button |
| 68 | +- [@vuepress/plugin-container](https://ecosystem.vuejs.press/plugins/container.html): Register markdown custom containers in your VuePress site. |
| 69 | +- [@vuepress/plugin-copy-code](https://ecosystem.vuejs.press/plugins/container.html): Provide copy button for code blocks. |
| 70 | +- [@vuepress/plugin-copyright](https://ecosystem.vuejs.press/plugins/container.html): Automatically append copyright information when visitors copy content, can also prohibit site copying or selection |
| 71 | +- [@vuepress/plugin-external-link-icon](https://ecosystem.vuejs.press/plugins/external-link-icon.html): Add a icon to the external link in your markdown content |
| 72 | +- [@vuepress/plugin-google-analytics](https://ecosystem.vuejs.press/plugins/google-analytics.html): Integrate [Google Analytics](https://analytics.google.com/) into VuePress. |
| 73 | +- [@vuepress/plugin-medium-zoom](https://ecosystem.vuejs.press/plugins/medium-zoom.html): Integrate [medium-zoom](https://github.com/francoischalifour/medium-zoom#readme) into VuePress, which can provide the ability to zoom images. |
| 74 | +- [@vuepress/plugin-nprogress](https://ecosystem.vuejs.press/plugins/nprogress.html): Integrate [nprogress](https://github.com/rstacruz/nprogress) into VuePress, which can provide a progress bar when navigating to another page. |
| 75 | +- [@vuepress/plugin-redirect](https://ecosystem.vuejs.press/plugins/redirect.html): Automatically handle redirects for your site. |
| 76 | +- [@vuepress/plugin-register-components](https://ecosystem.vuejs.press/plugins/register-components.html): Register Vue components from component files or directory automatically. |
| 77 | + |
| 78 | +#### Search |
| 79 | + |
| 80 | +- [@vuepress/plugin-docsearch](https://ecosystem.vuejs.press/plugins/docsearch.html): Integrate [Algolia DocSearch](https://docsearch.algolia.com/) into VuePress |
| 81 | +- [@vuepress/plugin-search](https://ecosystem.vuejs.press/plugins/search.html): Provide local search to your documentation site. |
| 82 | + |
| 83 | +#### Blogging |
| 84 | + |
| 85 | +- [@vuepress/plugin-blog](https://ecosystem.vuejs.press/plugins/blog/): Blog plugin |
| 86 | +- [@vuepress/plugin-feed](https://ecosystem.vuejs.press/plugins/feed/): Provide atom, json and rss feeds |
| 87 | + |
| 88 | +#### PWA |
| 89 | + |
| 90 | +- [@vuepress/plugin-pwa](https://ecosystem.vuejs.press/plugins/pwa.html): Make your VuePress site a [Progressive Web Application (PWA)](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps). |
| 91 | +- [@vuepress/plugin-pwa-popup](https://ecosystem.vuejs.press/plugins/pwa-popup.html): Provide a popup component for users to activate the new PWA service worker manually. |
| 92 | +- [@vuepress/plugin-remove-pwa](https://ecosystem.vuejs.press/plugins/remove-pwa.html): Removes any existing service worker from your VuePress site. |
| 93 | + |
| 94 | +#### SEO |
| 95 | + |
| 96 | +- [@vuepress/plugin-seo](https://ecosystem.vuejs.press/plugins/seo/): Provide SEO enhancement, including OGP and JSON-LD. |
| 97 | +- [@vuepress/plugin-sitemap](https://ecosystem.vuejs.press/plugins/sitemap/): Generate sitemap.xml for your site. |
| 98 | + |
| 99 | +#### Highlighting |
| 100 | + |
| 101 | +- [@vuepress/plugin-prismjs](https://ecosystem.vuejs.press/plugins/prismjs.html): Enable syntax highlighting for markdown code fence with [Prism.js](https://prismjs.com/) |
| 102 | +- [@vuepress/plugin-shiki](https://ecosystem.vuejs.press/plugins/shiki.html): Enable syntax highlighting for markdown code fence with [Shiki](https://shiki.matsu.io/) |
| 103 | + |
| 104 | +#### Theme developing |
| 105 | + |
| 106 | +- [@vuepress/plugin-active-header-links](https://ecosystem.vuejs.press/plugins/active-header-links.html): Update route hash when scrolling pages. |
| 107 | +- [@vuepress/plugin-git](https://ecosystem.vuejs.press/plugins/git.html): Collect git information of your pages, including the created and updated time, the contributors, etc. |
| 108 | +- [@vuepress/plugin-palette](https://ecosystem.vuejs.press/plugins/palette.html): Provide palette support for your theme. |
| 109 | +- [@vuepress/plugin-reading-time](https://ecosystem.vuejs.press/plugins/reading-time.html): Word count and reading time for each page. |
| 110 | +- [@vuepress/plugin-rtl](https://ecosystem.vuejs.press/plugins/rtl.html): Provide rtl support |
| 111 | +- [@vuepress/plugin-theme-data](https://ecosystem.vuejs.press/plugins/theme-data.html): Provide client data for your theme, with VuePress I18n support. |
| 112 | +- [@vuepress/plugin-toc](https://ecosystem.vuejs.press/plugins/toc.html): Provide a table-of-contents (TOC) component. |
70 | 113 |
|
71 | 114 | ### Community Plugins
|
72 | 115 |
|
73 |
| -- [vuepress-plugin-blog2](https://plugin-blog2.vuejs.press): VuePress2 Blog plugin📝 facing theme developers |
74 | 116 | - [vuepress-plugin-comment2](https://plugin-comment2.vuejs.press): VuePress2 comment plugin💬, supports Giscus, Twikoo and Waline.
|
75 | 117 | - [vuepress-plugin-components](https://plugin-components.vuejs.press): Markdown components out of box🧩
|
76 |
| -- [vuepress-plugin-copy-code2](https://plugin-copy-code2.vuejs.press): VuePress2 copy code plugin📋, provide copy button for code blocks. |
77 |
| -- [vuepress-plugin-copyright2](https://plugin-copyright2.vuejs.press): VuePress2 copyright plugin📋 |
78 |
| - |
79 |
| - Append copyright information while copying, also supports disabling copying and selection. |
80 |
| - |
81 |
| -- [vuepress-plugin-feed2](https://plugin-feed2.vuejs.press): VuePress2 feed plugin 📡, supporting atom, json and rss syntax feeds |
82 | 118 | - [vuepress-plugin-md-enhance](https://plugin-md-enhance.vuejs.press/): VuePress2 Markdown enhancement plugin📄
|
83 | 119 |
|
84 | 120 | Fully tree-shakable, features including attrs, tabs, code tabs, hint boxes, footnote, mark, subscript, superscript, snippets, imageTitle, imageLazyload, imageSize, imageMark, custom alignment, task lists, chart.js, flowchart.js, katex, mathjax, diagrams (mermaid), slides (reveal.js), playground, vue playground, code demos, etc.
|
85 | 121 |
|
86 | 122 | - [vuepress-plugin-photo-swipe](https://plugin-photo-swipe.vuejs.press/): VuePress2 photo preview plugin🔍 based on `photo-swipe`
|
87 | 123 | - [vuepress-plugin-pwa2](https://plugin-pwa2.vuejs.press/): VuePress2 PWA plugin📦, an improved edition over the official one.
|
88 |
| -- [vuepress-plugin-reading-time2](https://plugin-reading-time2.vuejs.press/): VuePress2 reading time plugin⏳ |
89 |
| -- [vuepress-plugin-redirect](https://plugin-redirect.vuejs.press/): VuePress2 redirect plugin↩️, performing automatically redirects from old links to new ones |
90 | 124 | - [vuepress-plugin-sass-palette](https://plugin-sass-palette.vuejs.press/): VuePress2 palette plugin for sass🎨, an improved edition over the official one.
|
91 | 125 | - [vuepress-plugin-search-pro](https://plugin-search-pro.vuejs.press/): VuePress2 plugin to provide client search, an improved edition over the official one.
|
92 |
| -- [vuepress-plugin-seo2](https://plugin-seo2.vuejs.press/): VuePress2 SEO plugin🛠, supports OGP and JSON-LD |
93 |
| -- [vuepress-plugin-sitemap2](https://plugin-sitemap2.vuejs.press/): VuePress2 Sitemap plugin🗺️ |
94 | 126 | - [vuepress-plugin-lightgallery](https://plugin-lightgallery.vuejs.press): Light Gallery plugin for VuePress2 (to provide image preview)
|
95 | 127 | - [vuepress-plugin-use-pages](https://github.com/monsat/vuepress-plugin-use-pages) - VuePress2 plugin that helps you use array of all PagesData in your doc.
|
96 | 128 | - [@snippetors/vuepress-plugin-tabs](https://www.npmjs.com/package/@snippetors/vuepress-plugin-tabs) - VuePress2 plugin which renders custom markdown containers as tabs, for vuepress v2.x
|
|
141 | 173 | - [vuepress-theme-dog](https://github.com/artiely/blog-dog): Opinionated vuepress blog theme. [Preview](https://artiely.github.io/?page=1)
|
142 | 174 | - [vuepress-theme-plume](https://pengzhanbo.cn/note/vuepress-theme-plume/) A Vuepress blog theme, low config,simple and beautiful.
|
143 | 175 | - [vuepress-theme-knzn](https://github.com/zhb333/vuepress-theme-knzn) A Vuepress awesome blog theme. [Preview](https://www.knzn.net/)
|
144 |
| -- [vuepress-theme-teadoc](https://github.com/wuwb/vuepress-theme-teadoc) A new doc theme base on @vuepress/theme-default. [Preview](https://lab.tongdelove.com/teadoc/) |
145 |
| -- [vuepress-theme-sidebar](https://github.com/dingshaohua-cn/vuepress-theme-sidebar) base on theme-default,autogenerate sidebar and right anchor. |
| 176 | +- [vuepress-theme-teadoc](https://github.com/wuwb/vuepress-theme-teadoc) A new doc theme base on @vuepress/theme-default. [Preview](https://lab.tongdelove.com/teadoc/) |
| 177 | +- [vuepress-theme-sidebar](https://github.com/dingshaohua-cn/vuepress-theme-sidebar) base on theme-default,autogenerate sidebar and right anchor. |
146 | 178 |
|
147 | 179 | ## Projects Using VuePress@v2
|
148 | 180 |
|
149 |
| -### Official Projects |
150 |
| - |
151 |
| -> To be completed. |
152 |
| -
|
153 |
| -### Blogging |
154 |
| - |
155 |
| -> Blog websites that use VuePress@v2. |
156 |
| -
|
157 |
| -- [Mr.Hope's Blog](https://mister-hope.com) |
158 |
| -- [Q.ben's Blog](https://blog.qbb.sh/) |
159 |
| -- [Renovamen's Blog](https://blog.zxh.io/) |
160 |
| -- [Azat's Blog](https://azat.io) |
161 |
| -- [NdagiStanley's web profile](https://md.engineer) |
162 |
| - |
163 | 181 | ### Open Source
|
164 | 182 |
|
165 | 183 | > Documentation websites that use VuePress@v2.
|
166 | 184 |
|
167 | 185 | - [Waline](https://waline.js.org): A safe and fast comment system
|
| 186 | +- [in 东师](https://innenu.com): 百万字的东师新生指南 |
| 187 | +- [zkSync](https://docs.zksync.io/): A trustless protocol that uses cryptographic validity proofs to provide scalable and low-cost transactions on Ethereum |
| 188 | +- [SubQuery](https://academy.subquery.network/): A leading web3 data indexer that provides fast, flexible, and decentralised APIs for web3 projects |
168 | 189 | - [Fast Request](https://dromara.org/fast-request): IntelliJ IDEA plugin RESTful Fast Request
|
169 | 190 | - [JavaGuide](https://javaguide.cn/): 「Java 学习+面试指南」一份涵盖大部分 Java 程序员所需要掌握的核心知识。
|
170 | 191 | - [Java 全栈知识体系](https://pdai.tech) - Java 全栈知识体系 (Java full stack knowledge system).
|
171 | 192 | - [ustc campus](https://ustc.gleamoe.com/): 中国科大夏令营指南与答疑汇总
|
172 | 193 | - [US-FE](https://us-fe.github.io/): US-FE 北美最大前端组织
|
173 |
| -- [LG G7 中级高手修炼手册](https://g7.lge.fun) - A chinese flashing manual for LG G7 |
174 |
| -- [LG 黑砖手册](https://hz.lge.fun) - a chinese flashing manual for all LG phones using sdm855 soc |
175 | 194 | - [MapStructPlus](https://mapstruct.plus):MapStructPlus 官方文档,MapStruct 中文文档
|
176 | 195 |
|
| 196 | +### Blogs |
| 197 | + |
| 198 | +> Blog websites that use VuePress@v2. |
| 199 | +
|
| 200 | +- [Mr.Hope's Blog](https://mister-hope.com) |
| 201 | + |
177 | 202 | ## License
|
178 | 203 |
|
179 | 204 | [](https://creativecommons.org/publicdomain/zero/1.0/)
|
|
0 commit comments