vuepress README

The project's README from github.com/vuejs/vuepress. As one markdown file: README.md.

logo

Downloads Version License VuePress channel on Discord

Status

VuePress v1 is now in maintenance mode.

For a next-gen Vue-based SSG:

Documentation

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

Showcase

Contribution

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

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

Evan You
Evan You

💻
ULIVZ
ULIVZ

💻 📖

Active Core Team

Billyyyyy3320
Billyyyyy3320

💻
meteorlxy
meteorlxy

💻
Ramona
Ramona

💻 📖
Franck Abgrall
Franck Abgrall

💻 💬

Core Team Emeriti

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

Ben Hong
Ben Hong

💻 📖 💬
Giraud Florent
Giraud Florent

💻
Sarah Dayan
Sarah Dayan

💻 📖
Vinayak Kulkarni
Vinayak Kulkarni

🔌 💻 📝
Victoria Bergquist
Victoria Bergquist

💻 🎨
Nikita Sobolev
Nikita Sobolev

💻 📖
Fatih Acet
Fatih Acet

💻
Vladimir Pouzanov
Vladimir Pouzanov

💻

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

License

MIT

vuepress (vuejs/vuepress)

Searching Database…

22.7K ·GitHub
这是什么?VuePress 是一个由 Vue 驱动的极简静态网站生成器:它把你的内容转换成快速的静态网站,最常用于文档站点和博客。
它是我写代码时引用的库,还是一个能构建整个网站的工具?它是一个生成器,不是组件库:你对自己的内容运行一次构建,就能得到一个完整的静态网站,可以托管在任何地方;页面渲染靠的是 Vue。
我怎么把它跑起来?README 里链接到了官方文档,上面有安装和入门说明。这套工具基于 Node,所以一切操作都要在终端里通过 npm 或 yarn 完成。
README 提到它处于维护模式 —— 新网站应该用哪个版本?v1 只做维护,不再新增功能。对于新项目,README 推荐两个选择:VitePress(Vue 团队基于 Vue 3 + Vite 的官方下一代静态站点生成器),或者 VuePress v2+(由社区维护,基于 Vue 3,可搭配 Vite、Webpack 等打包工具)。
大家通常用它做什么?文档站点和博客是它的核心用途;这个仓库自己的标签除了 static-site-generator 之外,还有 blog-engine、docs-generator 和 seo。
在哪里能看到用 VuePress 搭建的真实网站?README 的 Showcase 部分列出了 Awesome VuePress(一个精选的 VuePress 项目清单)和 vuepress.tools(由 Ahmad Mostafa 维护的一个网站目录)。
它生成的页面对 SEO 友好吗?SEO 本身就是这个项目的重点标签之一,而且由于页面是预先构建好的静态 HTML,搜索引擎不需要执行 JavaScript 就能收录它们。
不做本地配置,我能查看或修改源码吗?可以 —— README 建议直接从仓库用 Gitpod 打开 VuePress,Gitpod 是一个面向 GitHub 的免费在线 IDE。对代码或文档的实质性修改需要先经过 VuePress RFC 流程。
Creator
vuejs
Size
14.3 MB
Stars
22.7K
Age
8y
Commits · 90 Days