概述
欢迎使用 bW,本文档将帮助您快速上手,了解 bW 的使用方法。您也可以通过在 Github 上 fork 本文档工作包,帮助完善本文档。
什么是 bW
bW (a.k.a. Bo-blog Wind) 是一款轻量级个人博客程序,旨在为追求便捷的写作者提供一个简单、轻巧的文章发布工具。bW 使用 PHP 为运行脚本,采用 SQLite3 或 MySQL 数据库,并可在撰写中采用 Markdown 进行排版。
bW 有哪些特色?
bW正在做的、准备做到的有哪些特点呢?
首先,它是便携的。它可以很好地通过手机更新和维护,随身带好你的私人手机,无论是直接在手机上打开,还是扫一扫二维码、在别人的PC上临时登录,都能方便地使用bW。在安装时默认的选项是SQLite,也是出于迁移数据的便捷考虑。
其次,它不需要太多设置。bW在安装完成后,就可以直接拿来使用了,可能只要改一下博客的名字和描述而已。
此外,它不会频繁更新。bW将保持简洁、相对稳定。它的目标是够用,不至于周周升级月月更新,而违背了搭建一个博客的初衷。
当然,它也是可以扩展的。bW还是为插件、主题留出了相当大的发挥空间。
我听说过 bo-blog 2.0 甚至 1.0,它们和 bW 有什么关系?
bW是完全推到重写的,所以和bo-blog 2.0没有直接的关系,除了名字。前作固然有非常完善的功能和设置选项,但想要兼顾太多人的需求,导致了自身的臃肿和难以维护,出差错和漏洞也难免。所以 bW 并没有在前作的基础上进行升级,而是选择了全部重写。
如果您有兴趣知道创建 bW 这个程序的初衷,可以阅读这篇日志。
参与完善本文档
本文档在 GitHub 上进行托管。所有的文档页面都采用 MarkDown 撰写。
手册的项目地址在 https://github.com/bo-blog/bw-manual 。您可以 fork 它或 clone 到本地进行修改。
修改文档
您只需做的是修改 src/manual 目录下的相关 md 文件就可修改文档的内容。
新增文档
要新建一篇文档,在 src/manual 目录下创建新的 md 文件,输入新文档的内容即可。然后,请在 contents.md 文件中,增加新文档的链接。
预览
修改完毕后,可以在浏览器中运行项目根目录下的 generator.php。 这样就可以在 manual 目录下重新生成所有的 html 静态文件。请不要直接改动这些 html 文件,而是通过修改 src/manual 下的 md 文件来编写文档。 html 文件不会被 commit 到改动中。
提交修改
在完成修改后,可以提交并发起 pull 请求。审核通过的文档改动将被合并到 master 版本中。