my-pfds

📚 PFDS - 纯前端文档系统（Pure Frontend Document System）

快速完成文档编写，支持热更新，全局搜索，一键部署等功能。

PFDS 是一个基于纯前端技术构建的文档系统，无需后端服务即可快速搭建本地文档网站。适合用于项目说明、API 文档、教程指南等轻量级场景。使用简单的命令即可初始化、调试和部署文档站点。

项目文档地址：https://docs.shlm.top/pfds/

📦 版本更新日志

🧠 未来的更新想法

• 我打算在下个版本支持主题在线切换和更多特色写法，我的文档经验不足，我希望大家可以给我更多的思路。

✨ 新增功能

• 完善本地资源引用语法，增加@引用，代表使用本地的静态资源。
• 增PMD加图表语法：饼图，时序图

🔧 优化改进

• 优化页面显示逻辑，改为渐进式显示，大幅度提升用户体验。

🐛 Bug 修复

• 修复进度滚动错误问题。

🌟 核心特性

✨ 特性	描述
🚀 热更新开发	实时预览修改内容，提升文档编写效率
🎨 主题自由切换	提供默认白/深色主题，支持自定义 CSS 样式
📦 一键部署	生成静态 HTML 文件，轻松部署到 GitHub Pages/Vercel 等平台
📁 自动化导航	根据目录结构自动生成侧边栏和导航菜单
🔍 全局搜索	支持全局搜索，快速找到所需内容
📝 语法支持	支持 PMD（类markdown）、HTML 等多种格式
📚 低消耗	不涉及后端，全部计算均在访客端，您的服务器只需要消耗流量即可

📦 快速开始

1. 安装方式 [windows环境下PowerShell，而非cmd]

# 通过 npx 直接使用
npx pfds-init@latest

2. 启动开发服务器

pfds dev

🚀 访问 http://localhost:309 查看实时预览

3. 构建生产环境

pfds build

📦 静态文件输出到 output/ 目录

🧱 项目结构

my-project/
├──pfds.js               # pfds的执行js
├── output/              # 编译输出目录
│   ├── index.html       # 编译产物
│   └── assets/          # 静态资源
│         ├── js/
│         └── css/
├── dev/                 # 开发目录
│   ├──pfds.json         # 入口配置文件
│   ├── router.json      # 路由配置文件
│   ├── head.json        # 头部配置文件
│   ├── config.js        # 系统配置
│   ├── index.html/      # 主模板
│   └── assets/          # 静态资源
│   │   ├── js/
│   │   └── css/
│   └── views/           # 视图文件目录
│       └── home.html    # 示例视图文件
└── core/                # 核心JS模块
│   ├── build.js         # 构建脚本
│   └── themes/             # 静态资源
│   │    ├── dark.css   #黑暗主题的css
│   │    └── bright.css #明亮主题的css
│   └── modules/         # 功能模块
│      ├── 搜索.js
│      ├── 页面导航.js
│      └── ...其他模块

⚙️ 配置指南

// pfds.json 示例配置
{
    "siteTitle": "Pfds文档系统",
    "theme": "dark",
    "template": "main.html"
}

🎨 主题与样式

内置主题

• default: 🌞 浅色模式（默认）

自定义主题

• 在 core/themes/ 目录添加自定义 CSS 文件
• 通过配置文件选择即可

🤝 贡献指南

欢迎提交 Issues 和 Pull Requests！ 这个版本开始代码结构相当简单，我相信大家都可以轻松地修改和扩展，期待贡献。

📬 联系我们

如有问题或建议：

• 提交 GitHub Issue
• 邮件联系：[e-mail]

项目赞助

Temp Mail

❤️ 感谢使用 PFDS！希望它能助您高效管理文档！🎉