recovery old ph-Bookshelf handbook

This commit is contained in:
A.C.Sukazyo Eyre 2023-01-26 17:12:40 +08:00
commit 00ae5cf3c8
Signed by: Eyre_S
GPG Key ID: C17CE40291207874
5 changed files with 73 additions and 0 deletions

12
book.xml Normal file
View File

@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<Book id="ph-bookshelf" name="ph-Bookshelf 使用说明"
compatibility.article.title.oldversion="true"
>
<Page id="main" name="ph-Bookshelf" />
<Page id="install" name="安装使用" />
<Chapter name="Datas 书写">
<Page id="data-write/bookshelf" name="建立书架" />
</Chapter>
<Page id="custom" name="自定义网页样式" />
<Page id="plans" name="开发计划" />
</Book>

5
custom.md Normal file
View File

@ -0,0 +1,5 @@
你可以在 data 目录下建立 custom.css 文件和 custom.js 文件来自定义你的站点。
custom.css 中的内容会在预定义的 css 文件之后,作为 `<head>` 标签的最后一个子元素,内联进`<style>`输出。
custom.js 会在页面尾在预定义 js 输出后,通过内联进`<script>`

42
install.md Normal file
View File

@ -0,0 +1,42 @@
## 环境配置
ph-Bookshelf 是基于 php 的web程序所以你需要一个支持 php 的web服务器
同时ph-Bookshelf 使用了 php-xml 扩展,**若没有此扩展,会出现 `500` 错误**。
这个扩展在 php7.0 及以下还可能叫做 php-dom 扩展。
同时目前而言web服务器还需要支持 .htaccess 伪静态规则配置。
如果你使用的是 Apache 或是基于 Apache 的服务器,只需要确保 .htacces 支持和 Mod_Rewrite 处于打开状态(一般都是打开的);
但如果你使用的是 NgnixIIS亦或是其它不支持 .htaccess 的服务器,则需要根据下面的说明配置伪静态规则。
#### 伪静态配置
(待补)
## 下载 ph-Bookshelf
目前,唯一的官方获取 ph-Bookshelf 的方法是从 [GitHub 仓库][phb-repo]
clone/下载 最新代码。
<!--
这里演示了使用服务器 ssh 安装 ph-Bookshelf 的方案
```
$ cd /var/www/ # 进入你的服务器的网站根目录
$ git clone --depth=1 git@github.com:Eyre-S/ph-Bookshelf # 从 GitHub 仓库获取最新代码
$ mv ph-Bookshelf "<Name>" # 将 ph-Bookshelf 文件夹重命名为你想要的名字
```
-->
如果环境配置没有问题,那么现在这个站点就可以运行了...
是的,运行结果还是 ERROR Not Found。
但现在你可以下载
[预定义的 data 演示文件][demo-data]
来提前查看效站点运行果了
[phb-repo]: https://github.com/suk-ws/ph-Bookshelf
[demo-data]: https://srv.sukazyo.cc/resources/projects/ph-bookshelf/demo/data.zip

12
main.md Normal file
View File

@ -0,0 +1,12 @@
这是一个基于 Gitbook 的简单的多 book 实现。
因为 web 相关的东西 Sukazyo 最熟悉的就是 php 了所以就用 php 写的。
但是写出来的代码还是十分离谱的不易读的:各种调用交错在一起,前后端也交错在一起
而且也并不好用。
不过 Sukazyo 考虑到既然这么不好用,写一个使用说明大概就还挺必要的,反正也是随手的事情。
~~什么,你问示例站?这里不就是吗?~~
*这个项目还有[很多内容正在开发](/ph-bookshelf/plans)*

2
plans.md Normal file
View File

@ -0,0 +1,2 @@
待补充