Back to Vuepress

README

README.md

1.9.107.9 KB
Original Source
<p align="center"> <a href="https://vuepress.vuejs.org/" target="_blank"> </a> </p> <p align="center"> <a href="#"></a> <a href="https://www.npmjs.com/package/vuepress"></a> <a href="https://github.com/vuejs/vuepress/blob/master/LICENSE"></a> <a href="https://discordapp.com/invite/HBherRA"></a> </p>

Status

VuePress v1 is now in maintenance mode.

For a next-gen Vue-based SSG:

  • VitePress: Vue.js official team supported. Built on top of Vue 3 + Vite.
  • VuePress v2+: Community supported. Built on top of Vue 3 + Vite / Webpack / Other bundlers.

Documentation

Check out our docs at https://vuepress.vuejs.org/.

Showcase

Contribution

Want to contribute? Check our Contributing Guide and issues for beginners!

bash
yarn install # install all dependencies
yarn dev  # serves VuePress' own docs with itself
yarn test # make sure your code change pass the test

If you don't have a local checkout, you can also open VuePress in Gitpod, a free online IDE for GitHub.

If you intend to make "substantial" changes to VuePress or its documentation, please checkout VuePress RFCs.

If you have a VuePress-related project/component/tool, add it with a pull request to this curated list!

Contributors

Creator / Lead

<table> <td align="center"><a href="http://evanyou.me"> <sub><b>Evan You</b></sub></a> <a href="https://github.com/vuejs/vuepress/commits?author=yyx990803" title="Code">💻</a></td> <td align="center"><a href="https://github.com/ulivz"> <sub><b>ULIVZ</b></sub></a> <a href="https://github.com/vuejs/vuepress/commits?author=ulivz" title="Code">💻</a> <a href="https://github.com/vuejs/vuepress/commits?author=ulivz" title="Documentation">📖</a></td> </table>

Active Core Team

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://billychin.netlify.com/"> <sub><b>Billyyyyy3320</b></sub></a> <a href="https://github.com/vuejs/vuepress/commits?author=newsbielt703" title="Code">💻</a></td> <td align="center"><a href="https://github.com/meteorlxy"> <sub><b>meteorlxy</b></sub></a> <a href="https://github.com/vuejs/vuepress/commits?author=meteorlxy" title="Code">💻</a></td> <td align="center"><a href="https://twitter.com/CodesOfRa"> <sub><b>Ramona</b></sub></a> <a href="https://github.com/vuejs/vuepress/commits?author=CodesOfRa" title="Code">💻</a> <a href="https://github.com/vuejs/vuepress/commits?author=CodesOfRa" title="Documentation">📖</a></td> <td align="center"><a href="https://www.franck-abgrall.me/"> <sub><b>Franck Abgrall</b></sub></a> <a href="https://github.com/vuejs/vuepress/commits?author=kefranabg" title="Code">💻</a> <a href="#question-kefranabg" title="Answering Questions">💬</a></td> </tr> </table> <!-- markdownlint-enable --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->

Core Team Emeriti

Here we honor some no-longer-active core team members who have made valuable contributions in the past.

<table> <tr> <td align="center"><a href="http://www.bencodezen.io"> <sub><b>Ben Hong</b></sub></a> <a href="https://github.com/vuejs/vuepress/commits?author=bencodezen" title="Code">💻</a> <a href="https://github.com/vuejs/vuepress/commits?author=bencodezen" title="Documentation">📖</a> <a href="#question-bencodezen" title="Answering Questions">����</a></td> <td align="center"><a href="https://github.com/f3ltron"> <sub><b>Giraud Florent</b></sub></a> <a href="https://github.com/vuejs/vuepress/commits?author=f3ltron" title="Code">💻</a></td> <td align="center"><a href="https://frontstuff.io/"> <sub><b>Sarah Dayan</b></sub></a> <a href="https://github.com/vuejs/vuepress/commits?author=sarahdayan" title="Code">💻</a> <a href="https://github.com/vuejs/vuepress/commits?author=sarahdayan" title="Documentation">📖</a></td> <td align="center"><a href="https://twitter.com/_vinayak_k"> <sub><b>Vinayak Kulkarni</b></sub></a> <a href="#plugin-vinayakkulkarni" title="Plugin/utility libraries">🔌</a> <a href="https://github.com/vuejs/vuepress/commits?author=vinayakkulkarni" title="Code">💻</a> <a href="#blog-vinayakkulkarni" title="Blogposts">📝</a></td> <td align="center"><a href="https://twitter.com/vicbergquist"> <sub><b>Victoria Bergquist</b></sub></a> <a href="https://github.com/vuejs/vuepress/commits?author=vicbergquist" title="Code">💻</a> <a href="#design-vicbergquist" title="Design">🎨</a></td> <td align="center"><a href="https://sobolevn.me"> <sub><b>Nikita Sobolev</b></sub></a> <a href="https://github.com/vuejs/vuepress/commits?author=sobolevn" title="Code">💻</a> <a href="https://github.com/vuejs/vuepress/commits?author=sobolevn" title="Documentation">📖</a></td> <td align="center"><a href="https://fatihacet.com"> <sub><b>Fatih Acet</b></sub></a> <a href="https://github.com/vuejs/vuepress/commits?author=fatihacet" title="Code">💻</a></td> <td align="center"><a href="http://farcaller.net/"> <sub><b>Vladimir Pouzanov</b></sub></a> <a href="https://github.com/vuejs/vuepress/commits?author=farcaller" title="Code">💻</a></td> </tr> </table>

Code Contributors

This project exists thanks to all the people who contribute. [Contribute]. <a href="https://github.com/vuejs/vuepress/graphs/contributors"></a>

License

MIT