How vuejs/vuepress works
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: App.js Site app · registerCoreCommands.js CLI commands · Page.js Page processing · handleUnknownCommand.js Custom commands
Components 22
CLI and site context
- CLI commands
packages/vuepress/lib/registerCoreCommands.js - Custom commands
packages/vuepress/lib/handleUnknownCommand.js - Site app
packages/@vuepress/core/lib/node/App.js - Config loading
packages/@vuepress/core/lib/node/loadConfig.js - Theme resolution
packages/@vuepress/core/lib/node/loadTheme.js
Content processing
- Page processing
packages/@vuepress/core/lib/node/Page.js - Markdown engine
packages/@vuepress/markdown/index.js - Markdown loader
packages/@vuepress/markdown-loader/index.js - Page cache
packages/@vuepress/core/lib/node/CacheLoader.js - Page data mixin
packages/@vuepress/core/lib/node/ClientComputedMixin.js
Plugins and themes
- Plugin API
packages/@vuepress/core/lib/node/plugin-api/index.js - Built-in plugins
packages/@vuepress/core/lib/node/internal-plugins - Official plugins
packages/@vuepress/plugin-search/index.js - Themes
packages/@vuepress/theme-default/index.js
Site runtime
- Route generation
packages/@vuepress/core/lib/node/internal-plugins/routes.js - Generated client modules
packages/@vuepress/core/lib/node/plugin-api/override/ClientDynamicModulesOption.js - Development server
packages/@vuepress/core/lib/node/dev/index.js - Vue client app
packages/@vuepress/core/lib/client/app.js - Clean URL redirects
packages/@vuepress/core/lib/client/redirect.js - Search UI
packages/@vuepress/plugin-search/SearchBox.vue - Image zoom
packages/@vuepress/plugin-medium-zoom/clientRootMixin.js
Other components
- Site developer
Connections 19
- Site developer → CLI commands: runs commands
packages/vuepress/lib/registerCoreCommands.js - CLI commands → Site app: starts dev
packages/vuepress/lib/registerCoreCommands.js - CLI commands → Site app: builds site
packages/vuepress/lib/registerCoreCommands.js - CLI commands → Custom commands: handles unmatched
packages/vuepress/cli.js - Custom commands → Site app: prepares context
packages/vuepress/lib/handleUnknownCommand.js - Site app → Config loading: loads config
packages/@vuepress/core/lib/node/App.js - Site app → Theme resolution: loads theme
packages/@vuepress/core/lib/node/App.js - Site app → Plugin API: initializes plugins
packages/@vuepress/core/lib/node/App.js - Site app → Built-in plugins: registers built-ins
packages/@vuepress/core/lib/node/App.js - Site app → Page processing: processes pages
packages/@vuepress/core/lib/node/App.js - Page processing → Page data mixin: creates data mixin
packages/@vuepress/core/lib/node/App.js - Site app → Markdown engine: creates engine
packages/@vuepress/core/lib/node/App.js - Page processing → Markdown engine: uses engine
packages/@vuepress/core/lib/node/Page.js - Site app → Page cache: resolves cache options
packages/@vuepress/core/lib/node/App.js - Site app → Development server: starts server
packages/@vuepress/core/lib/node/App.js - Built-in plugins → Route generation: generates routes
packages/@vuepress/core/lib/node/internal-plugins/routes.js - Route generation → Generated client modules: writes client module
packages/@vuepress/core/lib/node/plugin-api/override/ClientDynamicModulesOption.js - Vue client app → Clean URL redirects: handles redirects
packages/@vuepress/core/lib/client/app.js - Image zoom → Image zoom: updates zoom
packages/@vuepress/plugin-medium-zoom/clientRootMixin.js