kkFileView 官网静态站点源码。当前维护分支已升级到 Node.js 最新版本运行,构建链路由旧的 docsite-ext + webpack 3 + node-sass 迁移为 Vite + Sass。
- Node.js
26.1.0+ - npm
11+
建议使用 .nvmrc 中声明的版本:
nvm use安装依赖:
npm install启动开发服务:
npm start默认监听端口为 8082:
http://127.0.0.1:8082/zh-cn/index.html
npm start 会先执行 npm run generate,生成首页、文档页、博客页需要的 HTML 和 Markdown JSON,再启动 Vite。
npm run build构建产物输出到 dist/。构建流程会自动:
- 生成站点 HTML 和 Markdown JSON
- 执行 Vite 生产构建
- 复制
img/、文档 JSON 等静态资源到dist/
本地预览生产构建:
npm run previewnpm run generate # 生成静态 HTML/JSON
npm start # 生成并启动开发服务,端口 8082
npm run build # 生成并构建生产产物
npm run preview # 预览 dist 产物,端口 8082
npm run lint # 代码检查
npm audit # 依赖安全检查- 不再依赖
docsite-ext、webpack 3、gulp、node-sass - Markdown 渲染逻辑在
scripts/generate-site.cjs - 页面
<title>、keywords、description配置在site_config/pageMeta.js - 构建后的静态资源补充复制逻辑在
scripts/copy-static.cjs - Vite 多页面入口配置在
vite.config.mjs - SCSS 已迁移到 Sass 模块语法
@use,不再使用废弃的@import
.github/workflows/deploy.yml 会在 main 分支推送后自动构建并通过 WinRM 发布到 Windows Nginx 站点目录。需要在 GitHub 仓库 Secrets 中配置:
KKVIEW_WINRM_HOST
KKVIEW_WINRM_USERNAME
KKVIEW_WINRM_PASSWORD
KKVIEW_WINRM_PORT
KKVIEW_DEPLOY_PATH
KKVIEW_REMOTE_ZIP_PATH
发布流程会把 dist.zip 切成小分片,通过 WinRM 上传到服务器,再由 scripts/deploy-winrm.py 合并分片、备份当前站点目录并替换官网静态文件。