快速开始

vanilla-press 是一款轻量、自由、高可定制的静态文档生成器。

只构建需要的，只使用想要的，把最终控制权留给用户。

特点

• 纯原生：无框架运行时依赖。
• 轻量级：输出资源简单、体积小。
• 个性化：轻松定制布局、样式和组件。
• 自由：按需选择运行时，只构建你需要的。
• 可扩展：支持依赖管理、client entry 与运行时增强。

安装

Shell
npm create vanilla-press@latest my-docscd my-docsnpm installnpm run dev

构建

构建命令会读取文档目录 docs/**/*.md、扩展与配置目录 vp/、静态资源目录 assets/，并按目录结构输出静态 HTML 文件到 dist/**/*.html，并生成相关的 CSS 与 JS 运行时。站点配置现在放在 vp/config/runtime.ts，其中构建阶段配置放在 server，浏览器运行时配置放在 client。

Shell
npm run server

Shell
npm run dev

项目架构

• dist/：HTML 站点输出目录，可直接部署到静态托管服务。
• dist/public/：构建后的静态资源目录，包含 CSS、JS、favicon、图片等。
• assets/：静态资源输入目录。
• docs/：文档输入目录，只放 Markdown 页面。
• vp/client/：项目自定义浏览器端公共代码、模块和页面入口。
• vp/components/：自定义组件。
• vp/config/：站点配置目录。
• vp/layouts/：自定义布局。

样式

vanilla-press 采用响应式布局策略，通过 CSS 媒体查询切换桌面端与窄屏端样式，运行时只为已渲染的 DOM 绑定必要交互。