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 — официальное новое поколение SSG от команды Vue на базе Vue 3 + Vite, — либо VuePress v2+, который поддерживается сообществом и работает на Vue 3 с Vite, Webpack или другими сборщиками.
Что обычно делают с его помощью?Основные сценарии — сайты документации и блоги; среди тем самого репозитория указаны blog-engine, docs-generator и seo, не считая static-site-generator.
Где посмотреть реальные сайты, сделанные на VuePress?В разделе Showcase README перечислены Awesome VuePress — подборка проектов на VuePress, — а также vuepress.tools, каталог, который ведёт Ahmad Mostafa.
Сгенерированный сайт хорош для SEO?SEO — один из собственных тегов проекта, а поскольку страницы заранее собраны в статический HTML, поисковики индексируют их без выполнения JavaScript.
Можно ли посмотреть или изменить исходный код без локальной настройки?Да — README предлагает открыть VuePress в Gitpod, бесплатной онлайн-IDE для GitHub, прямо из репозитория. Крупные изменения кода или документации сначала проходят через VuePress RFCs.
Creator
vuejs
Size
14.3 MB
Stars
22.7K
Age
8y
Commits · 90 Days