vuepress

mirror of https://github.com/vuejs/vuepress.git synced 2024-10-23 02:04:57 +08:00

📝 Minimalistic Vue-powered static site generator

blog-engine docs-generator seo static-site-generator vue vuepress

Go to file

Xinyu Liu 9fb4bb0092 docs: update project status		2024-05-15 18:16:20 +08:00
__mocks__	chore: refactor code style	2019-05-12 22:56:02 +08:00
.dependabot	config: add dependabot configuration (#2162 )	2020-07-21 10:51:18 -04:00
.github	feat: typescript support for config file (#2973 )	2021-12-23 04:05:29 +08:00
.vscode	workflow: using `monoo`	2023-02-26 03:22:09 +08:00
art	ui: add vector brand icons (#1627 )	2019-07-20 15:13:33 +08:00
changelog	chore: changelog for 1.9.2	2021-12-24 03:52:53 +08:00
packages	build: release version 1.9.10	2023-08-14 16:06:57 +08:00
rfcs	docs: fix textlint	2021-12-23 04:18:55 +08:00
scripts	ci: using `@nomadland/mono` for release flow (#2968 )	2021-12-21 03:46:20 +08:00
.all-contributorsrc	docs: update readme team members	2022-02-17 09:20:04 -05:00
.commitlintrc.js	ci: allow scope `types` for commit	2021-12-23 05:12:41 +08:00
.editorconfig	workflow: add .editorconfig (#719 )	2018-08-12 03:00:57 +08:00
.eslintignore	feat(types): init `@vuepress/types`	2021-12-24 00:41:09 +08:00
.eslintrc.js	build: use vue recommend eslint config	2019-12-03 19:11:12 +08:00
.gitignore	chore: add `amour1688.ts-in-markdown` as recommended vscode extension	2021-12-23 03:36:59 +08:00
.gitpod.yml	docs: update guide for project bootstrap	2020-03-18 18:00:04 +08:00
.npmignore	chore: update npmignore	2018-06-09 19:21:52 +08:00
babel.config.js	feat: typescript support for config file (#2973 )	2021-12-23 04:05:29 +08:00
CHANGELOG.md	chore(all): 1.9.10 changelog	2023-08-14 16:07:19 +08:00
CODE_OF_CONDUCT.md	Create CODE_OF_CONDUCT.md (#1736 )	2019-08-05 10:19:12 +08:00
lerna.json	build: release version 1.9.10	2023-08-14 16:06:57 +08:00
LICENSE	readme & license	2018-04-13 18:06:04 -04:00
package.json	workflow: using `monoo`	2023-02-26 03:22:09 +08:00
README.md	docs: update project status	2024-05-15 18:16:20 +08:00
tsconfig.json	fix(core): compatibility with node 10 (close: #2981 ) (#2992 )	2022-01-15 23:42:50 +08:00
yarn.lock	workflow: using `monoo`	2023-02-26 03:22:09 +08:00

README.md

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

Awesome VuePress
vuepress.tools (By Ahmad Mostafa)

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}
💻

_ULIVZ
💻 📖

Active Core Team

_{Billyyyyy3320}
💻

_meteorlxy
💻

_Ramona
💻 📖

_{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}
💻 📖 💬

_{Giraud Florent}
💻

_{Sarah Dayan}
💻 📖

_{Vinayak Kulkarni}
🔌 💻 📝

_{Victoria Bergquist}
💻 🎨

_{Nikita Sobolev}
💻 📖

_{Fatih Acet}
💻

_{Vladimir Pouzanov}
💻

Code Contributors

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

License

MIT