xfmpress 0.1.0 刚刚发布,这一版 0.1.1 没有动引擎代码,而是集中火力清理文档:安装命令写错了、端口号前后不一致、配置示例的形状不统一——这些都是新用户最容易卡住的地方。
这一版在解决什么
0.1.0 发布后,最刺眼的问题是文档里的安装命令写成了 npm i -D xfm,但 npm 上可安装的包名其实是 xfmpress(xfm 只是命令行工具的名字)。照着文档敲命令的用户会直接安装失败。这类"文档与实际不符"的问题,对一个新项目的第一印象伤害很大,所以这一版把它们一次性修完。
变了什么
Changed
- 英文
README.md成为 npm 页面的默认展示文档,中文版改放README_CN.md,两者互相链接。npm 是国际流量入口,英文优先展示能让更多用户看懂项目。 - 文档全面拆分为中英文成对文件:
README/README_CN、INSTALL/INSTALL_CN、PROGRAM/PROGRAM_CN,中文读者也有完整的一份。 - 开发服务器端口在所有文档和脚手架中统一修正为
4173。此前各处文档写的端口不一致,有4000也有4321,跟着不同页面操作会连不上服务器。 - 包描述改写为英文,与 npm 页面上的英文 README 保持一致。
Fixed
- 安装命令从错误的
npm i -D xfm修正为正确的包名xfmpress,命令行工具仍然叫xfm。 - 配置示例统一为
site: {}加顶层outDir的形状,避免用户照抄互相矛盾的示例。
升级要不要动手
不需要。0.1.1 没有任何代码变更,已安装的用户行为完全不变。只有一件事值得做:如果你的笔记或文章里引用过旧的安装命令,把它改成 npm i -D xfmpress 即可。对还没装过的新用户,照着修正后的安装教程走一遍即可,不会再遇到端口或命令对不上的问题。
评论