1
0
mirror of https://github.com/suk-ws/ph-Bookshelf.git synced 2024-12-05 09:26:52 +08:00
一个简单简洁(?)的文档书架实现。
Go to file
2023-03-08 18:34:32 +08:00
assets basic dark color for bread-card-markdown and main.css 2023-03-08 18:34:32 +08:00
src add support for book.xml config version 2.0 2023-02-26 22:23:45 +08:00
template add support for book.xml config version 2.0 2023-02-26 22:23:45 +08:00
.gitattributes 更新 readme 2021-11-23 17:41:16 +08:00
.gitignore fix gitignore problem 2023-01-29 12:49:19 +08:00
.htaccess 使id特殊字符不会出bug,整理输出缩进对齐与代码风格(书目页面目录缩进对齐还没做) 2021-11-25 03:37:47 +08:00
composer.json add support for highlightjs lang-plugins, bug fixes. 2023-01-29 10:41:50 +08:00
composer.lock add support for highlightjs lang-plugins, bug fixes. 2023-01-29 10:41:50 +08:00
constant.php 更新为 version 2.0 配置文件格式,书籍目录添加 Separator 支持,解析器部分跟进更新 2023-02-26 16:12:45 +08:00
index.php add support for book.xml config version 2.0 2023-02-26 22:23:45 +08:00
LICENSE 更新 LICENSE 为 MIT 2021-11-21 18:46:31 +08:00
README.md 添加 site.robots 参数支持了 robots.txt 2023-01-25 13:48:03 +08:00

ph-Bookshelf

一个可以在单一站点上放一大堆文档的文档托管项目——我们把它称之为书架。

因为 web 相关的东西 Sukazyo 最熟悉的就是 php 了所以就用 php 写的。 但是写出来的代码还是十分离谱的不易读的:各种调用交错在一起,前后端也交错在一起

而且也并不好用,不好用到几乎没办法写教程...那种...至少现在如此。

有时间的话会补充的en


安装

下载/clone此仓库的内容然后拖进 php 站点根目录即可。

web-server 环境要求

  • 支援 .htaccess 的 Webserver
    • 如果使用 Apache:
      • 启用模块 rewrite
        • 为网站根目录设置 AllowOverride All
    • 使用其它 Webserver可以自行查询如何将 .htaccess 规则转换为你所使用的网站配置并写进你的网站配置当中
  • PHP 版本 8.1 以上
    • PHP 模块 xml (也可能叫做 dom)
    • PHP 模块 mbstring
    • PHP 模块 fileinfo
    • composer 工具以安装项目依赖
    • 在 php.ini 中设置 display_errors 以及 display_startup_errorsOff (或者关闭 E_WARNING 及以下 log) (这是由于最开始写代码极不上心导致很多地方都会有可能报出 warn输出在屏幕上会导致很糟糕的使用体验)

使用

未来可能会拖出来一个示例之类的...


开源许可

MIT License.