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, которая также делает превью деплоя для их pull request'ов.
Можно ли использовать это в коммерческих проектах, и это бесплатно?Да — VitePress распространяется по лицензии MIT, так что его можно бесплатно использовать, менять и поставлять в составе коммерческих продуктов. Права принадлежат Юси (Ивану) Ю (Yuxi (Evan) You).
Как VitePress связан с VuePress?Это идейный наследник VuePress: та же идея генератора сайтов на Vue, но заново построенная поверх Vite. Живёт как отдельный проект в GitHub-организации vuejs, а не как релиз VuePress.
Поиск из коробки в сайте на VitePress есть?Да — поиск работает через интеграцию с Algolia DocSearch, а пакеты клиента DocSearch идут прямыми зависимостями самого VitePress. Команда Algolia сотрудничает с проектом, чтобы поддерживать эту интеграцию.
Можно попробовать без установки чего-либо?Да — плейграунд проекта работает в браузере на технологии WebContainers от StackBlitz, а для pull request'ов выпускаются мгновенные превью-релизы, так что покопаться в VitePress можно прямо из вкладки браузера.
Creator
vuejs
Size
19.4 MB
Stars
18.4K
Age
6y
Commits · 90 Days