Reading the repo
Opening the box…
Reading the repo
Opening the box…
How to install on Windows
📝 Minimalistic Vue-powered static site generator
Saved setup from 11 h ago
Will it work on Windows?
.github/CONTRIBUTING.mdThis project uses a monorepo setup that requires using Yarn because it relies on Yarn workspaces.
# Install all dependencies.
yarn
# Serves VuePress' own docs with itself.
yarn dev
# Build VuePress' own docs with itself.
yarn build
# Clean dependencies.
yarn clean
# Useful when creating new a package.
yarn boot
VuePress leverages jest for its tests, testing process depends on some setup located at scripts/test.js.
# Execute all the test suites.
yarn test
# Execute tests under specfic package.
yarn test -p=core ## OR --package=core
core: containing the Node.js API, the Plugin API, the Theme API, the Client SPA, etc.markdown: internal Markdown compiler.markdown-loader: internal Markdown loader.plugin-active-header-links: a plugin for active sidebar heading links.plugin-google-analytics: Google Analytics integration.plugin-last-updated: implementation of "last updated" feature.plugin-medium-zoom: medium-zoom integration.plugin-nprogress: nprogress integration.plugin-pwa: PWA plugin.plugin-search: search plugin, providing the SearchBox component.shared-utils: TypeScript utilities.test-utils: test utilities.theme-default: default theme.theme-vue: a theme tweak from default theme, used for the official Vue project.These projects are now available under VuePress group, contribution welcome!
Use one of the issues templates when you open a issue. And please ask questions on the StackOverflow.
We'll close your issue if you delete the template or it contains questions.
master) and merge back against that branch.(fix #xxxx) (#xxxx being the issue ID) in your PR title for a better release log, e.g. chore(feat): implement SSR (fix #1234).Check out RFC flow for more detail.
TODO
Commit messages should follow the commit message convention so that changelogs can be automatically generated.
Check out the availalbe types at @commitlint/config-conventional. And the scopes should be one of the followings:
cli
# Core Packages/packages:
core
markdown
...
theme-vue
Correct examples would be: fix($core): some message or feat: some message
Then run powershell -ExecutionPolicy Bypass -File .\setup.ps1. It stops at the first error and is safe to run again. Servers and tests aren't started; it lists them at the end. Read it first.
Needs Git: winget install Git.Git
git clone https://github.com/vuejs/vuepress.git cd vuepress
Node.js 14
winget install CoreyButler.NVMforWindows nvm install 14 nvm use 14
corepack enable yarn install
yarn dev
yarn test
No reports for Windows yet.
GitManual AI Agent reads the 4 key files and writes a step-by-step guide for Windows. Once written, it's saved for everyone.