Docs

Overview

The site vuejs.org is built with VitePress and depends on @vue/theme. The content on the site is written in Markdown format and located in the src directory. For simple edits, contributors can directly edit the files on GitHub and generate a Pull Request. The site recommends using pnpm as the package manager for local development and Node.js version 18 or higher for running the project.

Features

• Built with VitePress: The site is built using VitePress, a static site generator for Vue.
• Markdown Format: Content on the site is written in Markdown, making it easy to create and edit pages.
• GitHub Integration: Contributors can edit files directly on GitHub and submit Pull Requests for changes.
• Support for Vue Syntax: Ability to use Vue syntax inside Markdown for enhanced functionality.
• Writing Guide: Provides rules and recommendations for writing and maintaining documentation content.
• Theme Development: Instructions available for making changes to the theme alongside the documentation.

Installation

1. Clone the repository:

git clone <repository_url>

2. Install dependencies using pnpm:

pnpm install

3. Run the project with Node.js v18 or higher:

npm run dev

4. Enable corepack for better dependency management:

npm install -g corepack

Summary

The vuejs.org site is a documentation resource built with VitePress, offering support for Markdown content and Vue syntax. Contributors can easily make edits via GitHub and follow the provided writing guide. Theme development instructions are also available for enhancing the site’s appearance and functionality.