Docs
Documentation for Vue 3
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.
- Vitepress
VitePress is a static site generator designed for creating documentation websites. It offers a lightweight and fast development experience using Vue.js and Markdown, with features such as live-reload, theming, and customizable layout components.
- Vue
Vue.js is a lightweight and flexible JavaScript framework that allows developers to easily build dynamic and reactive user interfaces. Its intuitive syntax, modular architecture, and focus on performance make it a popular choice for modern web development.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
