https://github.com/vuejs/docs

📄 Documentation for Vue 3
https://github.com/vuejs/docs

docs hacktoberfest vue vue3

Last synced: 27 days ago
JSON representation

📄 Documentation for Vue 3

• Host: GitHub
• URL: https://github.com/vuejs/docs
• Owner: vuejs
• License: mit
• Created: 2019-12-15T09:54:28.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-14T19:29:05.000Z (7 months ago)
• Last Synced: 2024-04-14T23:03:38.016Z (7 months ago)
• Topics: docs, hacktoberfest, vue, vue3
• Language: Vue
• Homepage: https://vuejs.org
• Size: 16.3 MB
• Stars: 2,777
• Watchers: 59
• Forks: 4,005
• Open Issues: 120
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/contributing/oxford-comma.jpg
  • License: LICENSE

Awesome Lists containing this project

• awesome - vuejs/docs - 📄 Documentation for Vue 3 (Vue)

README

        
# vuejs.org

## Contributing

This site is built with [VitePress](https://github.com/vuejs/vitepress) and depends on [@vue/theme](https://github.com/vuejs/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](https://pnpm.io/) is preferred as package manager:

```bash

pnpm i

pnpm run dev

```

This project requires Node.js to be `v18` or higher. And it is recommended to enable corepack:

```bash

corepack enable

```

## Working on the content

- See VitePress docs on supported [Markdown Extensions](https://vitepress.dev/guide/markdown) and the ability to [use Vue syntax inside markdown](https://vitepress.dev/guide/using-vue).

- See the [Writing Guide](https://github.com/vuejs/docs/blob/main/.github/contributing/writing-guide.md) 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](https://github.com/vuejs/vue-theme#developing-with-real-content).