Browse Source

docs update

master
filesite 3 years ago
parent
commit
5cccfc2bdc
  1. 74
      www/content/README.md

74
www/content/README.md

@ -13,7 +13,7 @@ Markdown及其编辑器的普及,以及类似Jekyll以文件为基础的博客 @@ -13,7 +13,7 @@ Markdown及其编辑器的普及,以及类似Jekyll以文件为基础的博客
## 愿景
**进一步降低**内容分享者、内容创作者把内容变成网站的**门槛**,
**进一步降低**内容分享者、创作者把内容变成网站的**门槛**,
以常见的本地磁盘目录+文件的形式作为网站数据来源,
修改磁盘文件内容上传到服务器就可以生成网页,
让大家更易于同时维护本地和网站的内容。
@ -32,7 +32,22 @@ FileSite.io希望帮助到他们: @@ -32,7 +32,22 @@ FileSite.io希望帮助到他们:
filesite使用非常简单,一旦部署好之后,以后只需将本地最新内容上传覆盖即可。
1. 下载filesite源码,并参考[Nginx配置示例](./Nginx.conf.md)部署到你的服务器上;
用git下载:
```
git clone https://git.filesite.io/filesite/machete.git
```
或下载zip压缩包([点我直接下载](https://git.filesite.io/filesite/machete/archive/master.zip)):
```
https://git.filesite.io/filesite/machete/archive/master.zip
```
2. 修改配置文件``config/app.php``,简单设置后上传到服务器完成部署;
指定内容目录和使用的皮肤:
```
'content_directory' => 'content/', //内容存放目录
'theme' => 'manual', //皮肤名称,如:文档站选manual,图片站选googleimage
```
3. 将本地内容目录及文件上传到网站目录:``www/content/``
4. 打开网址浏览最新内容;
@ -42,19 +57,28 @@ filesite使用非常简单,一旦部署好之后,以后只需将本地最新 @@ -42,19 +57,28 @@ filesite使用非常简单,一旦部署好之后,以后只需将本地最新
## 在线体验
1. 文档站
* <a href="https://filesite.io" target="_blank">Filesite.io</a>
| 名称 | 网址 |
| ---- | ---- |
| FileSite | <a href="https://filesite.io" target="_blank">Filesite.io</a> |
2. 导航站
* 待续
-
3. 小说站
* 待续
-
4. 图片站
* <a href="https://googleimage.filesite.io" target="_blank">GoogleImage.Filesite.io</a>
| 名称 | 网址 |
| ---- | ---- |
| 看美女 | <a href="https://googleimage.filesite.io" target="_blank">GoogleImage.Filesite.io</a> |
5. 视频站
* 待续
-
## 源码下载
@ -65,25 +89,51 @@ Machete是砍刀,它能砍、能削、能切、能剁,最适合披荆斩棘 @@ -65,25 +89,51 @@ Machete是砍刀,它能砍、能削、能切、能剁,最适合披荆斩棘
Filesite.io也一样,它短小精悍,使用它把常见的本地文件制作成网站,就像拿起砍刀一样简单, 所以我们将filesite.io的源码命名为**machete**。
点击下面网址查看源码或者下载源码:
* 查看<a href="https://git.filesite.io/filesite/machete" target="_blank">filesite.io源码Machete</a>
用git下载:
* 用git下载:
```
git clone https://git.filesite.io/filesite/machete.git
```
去查看<a href="https://git.filesite.io/filesite/machete" target="_blank">filesite.io源码Machete</a>
* 还可以下载zip压缩包([点我直接下载](https://git.filesite.io/filesite/machete/archive/master.zip)):
```
https://git.filesite.io/filesite/machete/archive/master.zip
```
## 皮肤下载
皮肤介绍如下:
FileSite.io官方提供的皮肤都包含在最新版的源码目录```themes/```中,详情如下:
| 皮肤名称 | 目录名 | 适用网站类型 |
| ---- | ---- | ---- |
| Manual | manual | 文档站 |
| GoogleImage | googleimage | 图片站 |
官方皮肤介绍如下:
* [文档站皮肤Manual](./Theme_Manual.md)
* [图片站皮肤GoogleImage](./Theme_GoogleImage.md)
第三方提供的皮肤下载:
| 皮肤名称 | 目录名 | 适用网站类型 | 下载地址 |
| ---- | ---- | ---- | ---- |
| - | - | - | - |
如果你基于Machete开发了皮肤想要共享给大家使用,
请在这里提交:
待续
## 使用手册
如果要基于Machete做二次开发,请先仔细阅读下面手册。
filesite.io核心代码参考:
* [Filesite.io core lib](./FSC.md)
* [Nginx配置示例](./Nginx.conf.md)
@ -93,6 +143,10 @@ filesite.io二次开发参考: @@ -93,6 +143,10 @@ filesite.io二次开发参考:
* [类DirScanner定义](./Class_DirScanner.md)
如果上面的手册还不能帮助解决你的问题,
请按下面方式提交反馈与建议。
## 反馈与建议
待续

Loading…
Cancel
Save