diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index f7572c26..2e707fef 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -32,6 +32,7 @@ export default defineConfig({ text: 'Guide', items: [ { text: 'Getting Started', link: '/guide/' }, + { text: 'Features', link: '/guide/features/' }, ], }, { diff --git a/docs/guide/features.md b/docs/guide/features.md new file mode 100644 index 00000000..6aeff6d8 --- /dev/null +++ b/docs/guide/features.md @@ -0,0 +1,104 @@ +--- +outline: deep +--- + +# Features + +Discover all the features Vite Devtools offers. + +## Overview + +Shows a quick overview of your app's build analysis, including the build entries, build duration, build directory, number of modules, plugins and more. + +![overview](/features/overview.png) + +## Modules + +Display all files in the bundle in list, detailed list, graph, and folder tree views. + +Supports file type filtering and fuzzy search for finding modules. + +![modules](/features/modules.png) + +Module transformation flow (Parse -> Resolve -> Transform -> Chunk -> Bundle -> Output). + +Track the entire process, find bottlenecks and optimizations. + +![module-build-flow](/features/module-build-flow.png) + +Module Relationship Graph: + +![module-relationship-graph](/features/module-graph.png) + +Bundled files in folder tree view: + +![module-tree](/features/module-tree.png) + +In the graph view, the path selector allows you to trace dependencies between 2 modules. + +![module-path-selector](/features/module-path-selector.png) + +## Plugins + +Display all plugins, both official and third-party. Supports plugin type filtering and fuzzy search for finding plugins. + +![plugins](/features/plugins.png) + +In the plugin details view, see hook costs (Resolve Id, Load, Transform) and processed modules in Build Flow or Sunburst views. + +![plugin-details](/features/plugin-details.png) + +## Chunks + +Display all chunks in your build output in list, detailed list, and graph views. + Supports fuzzy search for finding chunks. + +![chunks](/features/chunks.png) + +In the graph view, the path selector allows you to trace references between 2 chunks. + +![chunk-path-selector](/features/chunk-path-selector.png) + +Click a chunk to see details including filename, size, all included modules and more. + +![chunk-details](/features/chunk-details.png) + +## Assets + +Display all static assets in your build output in list, folder tree, treemap, sunburst, and flamegraph views. Supports fuzzy search for finding assets. + +![assets](/features/assets.png) + +Asset Treemap View: + +![asset-treemap](/features/asset-treemap.png) + +Asset Suburst View: + +![asset-sunburst](/features/asset-sunburst.png) + +Click an asset to view details including name, size, related chunks, and asset relationships. + +![asset-details](/features/asset-details.png) + +## Packages + +Display all npm dependencies in your bundle in table and treemap views, and detect duplicated packages, including both direct and transitive dependencies. + +Supports dependency type filtering (direct/transitive) and fuzzy search for finding packages. + +![packages](/features/packages.png) + +Packages Size Graph View: + +![package-treemap](/features/package-treemap.png) + +Click a package to see details including name, size, bundled files and more. + +![package-details](/features/package-details.png) + +## Session Compare + +Compare and analyze the bundle changes, including bundle size, initial js size, number of modules, plugins, chunks, assets. + +![session-compare](/features/session-compare.png) diff --git a/docs/public/features/asset-details.png b/docs/public/features/asset-details.png new file mode 100644 index 00000000..c9bc7683 Binary files /dev/null and b/docs/public/features/asset-details.png differ diff --git a/docs/public/features/asset-sunburst.png b/docs/public/features/asset-sunburst.png new file mode 100644 index 00000000..ae9645c3 Binary files /dev/null and b/docs/public/features/asset-sunburst.png differ diff --git a/docs/public/features/asset-treemap.png b/docs/public/features/asset-treemap.png new file mode 100644 index 00000000..9bcf7461 Binary files /dev/null and b/docs/public/features/asset-treemap.png differ diff --git a/docs/public/features/assets.png b/docs/public/features/assets.png new file mode 100644 index 00000000..309d3ebd Binary files /dev/null and b/docs/public/features/assets.png differ diff --git a/docs/public/features/chunk-details.png b/docs/public/features/chunk-details.png new file mode 100644 index 00000000..f34c9da1 Binary files /dev/null and b/docs/public/features/chunk-details.png differ diff --git a/docs/public/features/chunk-path-selector.png b/docs/public/features/chunk-path-selector.png new file mode 100644 index 00000000..a9aa0c25 Binary files /dev/null and b/docs/public/features/chunk-path-selector.png differ diff --git a/docs/public/features/chunks.png b/docs/public/features/chunks.png new file mode 100644 index 00000000..cbf628f8 Binary files /dev/null and b/docs/public/features/chunks.png differ diff --git a/docs/public/features/module-build-flow.png b/docs/public/features/module-build-flow.png new file mode 100644 index 00000000..ca1a617b Binary files /dev/null and b/docs/public/features/module-build-flow.png differ diff --git a/docs/public/features/module-graph.png b/docs/public/features/module-graph.png new file mode 100644 index 00000000..caea92aa Binary files /dev/null and b/docs/public/features/module-graph.png differ diff --git a/docs/public/features/module-path-selector.png b/docs/public/features/module-path-selector.png new file mode 100644 index 00000000..374f7dc1 Binary files /dev/null and b/docs/public/features/module-path-selector.png differ diff --git a/docs/public/features/module-tree.png b/docs/public/features/module-tree.png new file mode 100644 index 00000000..77f3e7e7 Binary files /dev/null and b/docs/public/features/module-tree.png differ diff --git a/docs/public/features/modules.png b/docs/public/features/modules.png new file mode 100644 index 00000000..05129dec Binary files /dev/null and b/docs/public/features/modules.png differ diff --git a/docs/public/features/overview.png b/docs/public/features/overview.png new file mode 100644 index 00000000..58612f33 Binary files /dev/null and b/docs/public/features/overview.png differ diff --git a/docs/public/features/package-details.png b/docs/public/features/package-details.png new file mode 100644 index 00000000..41edb2dd Binary files /dev/null and b/docs/public/features/package-details.png differ diff --git a/docs/public/features/package-treemap.png b/docs/public/features/package-treemap.png new file mode 100644 index 00000000..72589459 Binary files /dev/null and b/docs/public/features/package-treemap.png differ diff --git a/docs/public/features/packages.png b/docs/public/features/packages.png new file mode 100644 index 00000000..aaa52e88 Binary files /dev/null and b/docs/public/features/packages.png differ diff --git a/docs/public/features/plugin-details.png b/docs/public/features/plugin-details.png new file mode 100644 index 00000000..fb66ac7d Binary files /dev/null and b/docs/public/features/plugin-details.png differ diff --git a/docs/public/features/plugins.png b/docs/public/features/plugins.png new file mode 100644 index 00000000..3aca4daf Binary files /dev/null and b/docs/public/features/plugins.png differ diff --git a/docs/public/features/session-compare.png b/docs/public/features/session-compare.png new file mode 100644 index 00000000..e2a5a2df Binary files /dev/null and b/docs/public/features/session-compare.png differ