dgtlmoon / embeddedwiki
一个超轻量级的PHP/JS微型Wiki工具,适用于希望将Wiki嵌入到现有页面并且只需要有限功能集的用户。
v1.0.0
2021-01-06 20:14 UTC
Requires
- php: >=7.1.0
- ezyang/htmlpurifier: ^4.13
README
一个超轻量级的PHP/JS微型Wiki工具,适用于希望将Wiki嵌入到现有页面并且只需要有限功能集的用户。
注意:目前这更像是发现实现此类功能所需代码最少的实验,但欢迎您的建议/拉取请求!
功能
- 不需要任何前端构建工具。
- 使用
ezyang/HTMLPurifier
进行输入/输出净化。 - 使用HTML5
contentEditable
进行编辑。 - 使用纯内联JavaScript实现所有功能。
在几个浏览器上完全未测试 :)
安装
需要SQLite支持以进行版本控制。(希望将来使其可扩展以支持其他格式)
安装composer包。
示例
- 只需将其放入您需要快速Wiki的页面即可!
- 将
/writeable/path/to/sqlitedbs
更改为您的Web服务器可以读取/写入的路径。 - 在更新
receiver.php
中更改相同路径
$page_name = "some identifier"; require __DIR__ . '/vendor/autoload.php'; $wiki = new Embeddedwiki($page_name, "/writeable/path/to/sqlitedbs"); print $wiki->render();
安全
所有输入/输出都通过ezyang/HTMLPurifier
传递
未来
- 添加测试
- 显示修订ID列表,点击显示该修订或回滚
- 记录IP/日期/时间等
- 更清晰的OO,抽象存储等