vitepress README

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

VitePress 📝💨

test npm nightly releases chat


VitePress is a Vue-powered static site generator and a spiritual successor to VuePress, built on top of Vite.

Documentation

To check out docs, visit vitepress.dev.

Changelog

Detailed changes for each release are documented in the CHANGELOG.

Contribution

Please make sure to read the Contributing Guide before making a pull request.

License

MIT

Copyright (c) 2019-present, Yuxi (Evan) You

Special Thanks

This project would not be possible without the support of these amazing companies and tools.

VoidZero's logo VoidZero The company behind Vite, Vitest, Rolldown, and Oxc. VoidZero has been a long-time sponsor of VitePress. VitePress itself is built on top of this ecosystem of high-performance JavaScript tooling.
StackBlitz's logo StackBlitz Creators of WebContainers and a browser-based development platform. Their technology powers the VitePress playground and provides instant preview releases for our pull requests and commits.
Algolia's logo Algolia An AI-powered search platform that provides fast, scalable search. Algolia powers DocSearch for VitePress. Their team has been a long-time partner in building and maintaining our search integration.
BrowserStack's logo BrowserStack A cloud-based testing platform for websites and mobile apps. BrowserStack provides the cross-browser and real-device infrastructure used to ensure VitePress works consistently across all browsers.
Netlify's logo Netlify A platform for building, deploying, and hosting modern web projects. Netlify powers our website deployments with their generous open source plan and provides deploy previews for the pull requests.

vitepress (vuejs/vitepress)

Searching Database…

18.4K ·GitHub
这是什么?VitePress 是一个由 Vue 驱动、基于 Vite 构建的静态网站生成器,可以看作 VuePress 的精神续作,主要面向文档类网站。
那它是用来搭建网站的工具,还是需要往代码里引入的库?它是一个构建工具:你把 Markdown 和 Vue 内容交给它处理,它就会编译出一个可以直接部署的静态网站。访问者看到的只是普通的网页,不需要服务器为他们运行任何东西。
如果我想用它搭一个文档网站,应该从哪里开始?README 本身没有给出安装命令,而是指向 vitepress.dev 上的官方文档——里面的 Getting Started 指南会一步步带你创建并构建一个新网站。
做好的网站可以托管在哪里?任何能提供静态文件的地方都可以,因为生成的就是普通网页。VitePress 团队自己的网站就托管在 Netlify 上,Netlify 还为他们的 pull request 提供部署预览。
我可以在商业项目里用它吗?它是免费的吗?可以——VitePress 采用 MIT 许可证,可以免费使用、修改并用于商业产品。版权归属 Yuxi (Evan) You。
VitePress 和 VuePress 是什么关系?它是 VuePress 的精神续作:同样是 Vue 驱动的网站生成器,但改在 Vite 之上重新构建。它作为独立项目放在 vuejs GitHub 组织下,并不是 VuePress 的一个版本。
VitePress 网站自带搜索功能吗?有——搜索通过 Algolia 的 DocSearch 集成实现,而且 DocSearch 客户端包本身就是 VitePress 的直接依赖。Algolia 团队与该项目合作维护这个集成。
不安装任何东西也能试用吗?可以——项目的 playground 基于 StackBlitz 的 WebContainers 技术在浏览器里运行,而且每个 pull request 都会获得即时预览版本,你可以直接在浏览器标签页里体验 VitePress。
Creator
vuejs
Size
19.4 MB
Stars
18.4K
Age
6y
Commits · 90 Days