# vuejs/vuepress architecture

> Architecture diagram of the GitHub repository vuejs/vuepress, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vuejs/vuepress
- Repository: https://github.com/vuejs/vuepress

## Overview

VuePress v1 is a Vue-based documentation generator. The main workflow is a developer invoking the CLI, which creates and processes a site context, resolves configuration and a theme, turns source files into pages, and serves or builds the result; generated routes then drive the Vue client. The tree also shows a plugin ecosystem, themes, Markdown processing, and client-side features. Several of those modules are unsampled, so their presence is represented without guessing internal call relationships; edges cite only visible source relationships.

Main entry points: [`packages/@vuepress/core/lib/node/App.js`](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/App.js) (Site app), [`packages/vuepress/lib/registerCoreCommands.js`](https://github.com/vuejs/vuepress/blob/master/packages/vuepress/lib/registerCoreCommands.js) (CLI commands), [`packages/@vuepress/core/lib/node/Page.js`](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/Page.js) (Page processing), [`packages/vuepress/lib/handleUnknownCommand.js`](https://github.com/vuejs/vuepress/blob/master/packages/vuepress/lib/handleUnknownCommand.js) (Custom commands)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["CLI and site context"]
  node_cli["CLI commands"]
  node_unknown["Custom commands"]
  node_app["Site app<br/>[App.js]"]
  node_config["Config loading<br/>[loadConfig.js]"]
  node_theme["Theme resolution<br/>[loadTheme.js]"]
end

subgraph group_content["Content processing"]
  node_page["Page processing<br/>[Page.js]"]
  node_markdown["Markdown engine<br/>[index.js]"]
  node_markdownloader["Markdown loader<br/>[index.js]"]
  node_cache[("Page cache<br/>[CacheLoader.js]")]
  node_computed["Page data mixin"]
end

subgraph group_extensions["Plugins and themes"]
  node_pluginapi["Plugin API<br/>[index.js]"]
  node_plugins["Built-in plugins"]
  node_officialplugins["Official plugins<br/>[index.js]"]
  node_themes["Themes<br/>[index.js]"]
end

subgraph group_runtime["Site runtime"]
  node_routes["Route generation<br/>[routes.js]"]
  node_tempmodules["Generated client modules"]
  node_devserver["Development server<br/>[index.js]"]
  node_client["Vue client app<br/>[app.js]"]
  node_redirect["Clean URL redirects<br/>[redirect.js]"]
  node_search["Search UI<br/>[SearchBox.vue]"]
  node_zoom["Image zoom<br/>[clientRootMixin.js]"]
end

node_developer(("Site developer"))

node_developer -->|"runs commands"| node_cli
node_cli -->|"starts dev"| node_app
node_cli -->|"builds site"| node_app
node_cli -->|"handles unmatched"| node_unknown
node_unknown -->|"prepares context"| node_app
node_app -->|"loads config"| node_config
node_app -->|"loads theme"| node_theme
node_app -->|"initializes plugins"| node_pluginapi
node_app -->|"registers built-ins"| node_plugins
node_app -->|"processes pages"| node_page
node_page -->|"creates data mixin"| node_computed
node_app -->|"creates engine"| node_markdown
node_page -->|"uses engine"| node_markdown
node_app -->|"resolves cache options"| node_cache
node_app -->|"starts server"| node_devserver
node_plugins -->|"generates routes"| node_routes
node_routes -->|"writes client module"| node_tempmodules
node_client -->|"handles redirects"| node_redirect
node_zoom -->|"updates zoom"| node_zoom

click node_cli "https://github.com/vuejs/vuepress/blob/master/packages/vuepress/lib/registerCoreCommands.js"
click node_unknown "https://github.com/vuejs/vuepress/blob/master/packages/vuepress/lib/handleUnknownCommand.js"
click node_app "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/App.js"
click node_config "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/loadConfig.js"
click node_theme "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/loadTheme.js"
click node_pluginapi "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/plugin-api/index.js"
click node_plugins "https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/core/lib/node/internal-plugins"
click node_officialplugins "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/plugin-search/index.js"
click node_themes "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/theme-default/index.js"
click node_page "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/Page.js"
click node_markdown "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/markdown/index.js"
click node_markdownloader "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/markdown-loader/index.js"
click node_cache "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/CacheLoader.js"
click node_computed "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/ClientComputedMixin.js"
click node_routes "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/internal-plugins/routes.js"
click node_tempmodules "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/plugin-api/override/ClientDynamicModulesOption.js"
click node_devserver "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/dev/index.js"
click node_client "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/client/app.js"
click node_redirect "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/client/redirect.js"
click node_search "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/plugin-search/SearchBox.vue"
click node_zoom "https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/plugin-medium-zoom/clientRootMixin.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_unknown,node_app,node_config,node_theme toneBlue
class node_page,node_markdown,node_markdownloader,node_cache,node_computed toneAmber
class node_pluginapi,node_plugins,node_officialplugins,node_themes toneMint
class node_routes,node_tempmodules,node_devserver,node_client,node_redirect,node_search,node_zoom toneRose
class node_developer toneIndigo
```

## Components

### CLI and site context

- [CLI commands](https://github.com/vuejs/vuepress/blob/master/packages/vuepress/lib/registerCoreCommands.js): `packages/vuepress/lib/registerCoreCommands.js`
- [Custom commands](https://github.com/vuejs/vuepress/blob/master/packages/vuepress/lib/handleUnknownCommand.js): `packages/vuepress/lib/handleUnknownCommand.js`
- [Site app](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/App.js): `packages/@vuepress/core/lib/node/App.js`
- [Config loading](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/loadConfig.js): `packages/@vuepress/core/lib/node/loadConfig.js`
- [Theme resolution](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/loadTheme.js): `packages/@vuepress/core/lib/node/loadTheme.js`

### Content processing

- [Page processing](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/Page.js): `packages/@vuepress/core/lib/node/Page.js`
- [Markdown engine](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/markdown/index.js): `packages/@vuepress/markdown/index.js`
- [Markdown loader](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/markdown-loader/index.js): `packages/@vuepress/markdown-loader/index.js`
- [Page cache](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/CacheLoader.js): `packages/@vuepress/core/lib/node/CacheLoader.js`
- [Page data mixin](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/ClientComputedMixin.js): `packages/@vuepress/core/lib/node/ClientComputedMixin.js`

### Plugins and themes

- [Plugin API](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/plugin-api/index.js): `packages/@vuepress/core/lib/node/plugin-api/index.js`
- [Built-in plugins](https://github.com/vuejs/vuepress/tree/master/packages/%40vuepress/core/lib/node/internal-plugins): `packages/@vuepress/core/lib/node/internal-plugins`
- [Official plugins](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/plugin-search/index.js): `packages/@vuepress/plugin-search/index.js`
- [Themes](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/theme-default/index.js): `packages/@vuepress/theme-default/index.js`

### Site runtime

- [Route generation](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/internal-plugins/routes.js): `packages/@vuepress/core/lib/node/internal-plugins/routes.js`
- [Generated client modules](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/plugin-api/override/ClientDynamicModulesOption.js): `packages/@vuepress/core/lib/node/plugin-api/override/ClientDynamicModulesOption.js`
- [Development server](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/node/dev/index.js): `packages/@vuepress/core/lib/node/dev/index.js`
- [Vue client app](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/client/app.js): `packages/@vuepress/core/lib/client/app.js`
- [Clean URL redirects](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/core/lib/client/redirect.js): `packages/@vuepress/core/lib/client/redirect.js`
- [Search UI](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/plugin-search/SearchBox.vue): `packages/@vuepress/plugin-search/SearchBox.vue`
- [Image zoom](https://github.com/vuejs/vuepress/blob/master/packages/%40vuepress/plugin-medium-zoom/clientRootMixin.js): `packages/@vuepress/plugin-medium-zoom/clientRootMixin.js`

### Other components

- **Site developer**

## Connections

- Site developer → CLI commands: runs commands (evidence: `packages/vuepress/lib/registerCoreCommands.js`)
- CLI commands → Site app: starts dev (evidence: `packages/vuepress/lib/registerCoreCommands.js`)
- CLI commands → Site app: builds site (evidence: `packages/vuepress/lib/registerCoreCommands.js`)
- CLI commands → Custom commands: handles unmatched (evidence: `packages/vuepress/cli.js`)
- Custom commands → Site app: prepares context (evidence: `packages/vuepress/lib/handleUnknownCommand.js`)
- Site app → Config loading: loads config (evidence: `packages/@vuepress/core/lib/node/App.js`)
- Site app → Theme resolution: loads theme (evidence: `packages/@vuepress/core/lib/node/App.js`)
- Site app → Plugin API: initializes plugins (evidence: `packages/@vuepress/core/lib/node/App.js`)
- Site app → Built-in plugins: registers built-ins (evidence: `packages/@vuepress/core/lib/node/App.js`)
- Site app → Page processing: processes pages (evidence: `packages/@vuepress/core/lib/node/App.js`)
- Page processing → Page data mixin: creates data mixin (evidence: `packages/@vuepress/core/lib/node/App.js`)
- Site app → Markdown engine: creates engine (evidence: `packages/@vuepress/core/lib/node/App.js`)
- Page processing → Markdown engine: uses engine (evidence: `packages/@vuepress/core/lib/node/Page.js`)
- Site app → Page cache: resolves cache options (evidence: `packages/@vuepress/core/lib/node/App.js`)
- Site app → Development server: starts server (evidence: `packages/@vuepress/core/lib/node/App.js`)
- Built-in plugins → Route generation: generates routes (evidence: `packages/@vuepress/core/lib/node/internal-plugins/routes.js`)
- Route generation → Generated client modules: writes client module (evidence: `packages/@vuepress/core/lib/node/plugin-api/override/ClientDynamicModulesOption.js`)
- Vue client app → Clean URL redirects: handles redirects (evidence: `packages/@vuepress/core/lib/client/app.js`)
- Image zoom → Image zoom: updates zoom (evidence: `packages/@vuepress/plugin-medium-zoom/clientRootMixin.js`)
