mrkhosravian / docs

📄 Documentation for Vue 3

vuejs.org

Contributing

This site is built with VitePress and depends on @vue/theme. Site content is written in Markdown format located in src. For simple edits, you can directly edit the file on GitHub and generate a Pull Request.

For local development, pnpm is preferred as package manager:

pnpm i
pnpm run dev

This project requires Node.js to be v14.0.0 or higher, because we use new JavaScript features in our code, such as optional chaining.

Working on the content

• See VitePress docs on supported Markdown Extensions and the ability to use Vue syntax inside markdown.

• See the Writing Guide for our rules and recommendations on writing and maintaining documentation content.

Working on the theme

If changes need to made for the theme, check out the instructions for developing the theme alongside the docs.