From d6062c3b3a96bc1335f6363e71f842caf1769db3 Mon Sep 17 00:00:00 2001 From: filesite Date: Sun, 8 May 2022 11:53:29 +0800 Subject: [PATCH] Readme update --- README.md | 89 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 76 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6977a5d..9ed7ff7 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,24 @@ # filesite.io - 无数据库、基于文件和目录的Markdown文档、网址导航、图书、图片、视频网站PHP开源系统 ![Filesite.io - Machete](./machete_icon.png) -## 简介 -项目名称：**filesite.io** +Markdown及其编辑器的普及，以及类似Jekyll以文件为基础的博客系统的出现，为博主们提供了一种更为专注的写作方式， +在自己的电脑本地且不必联网的情况下就能创作，不再依赖于像WordPress这类系统后台。 -项目介绍： +对于喜欢写作的创作者们，显然已经从Markdown的使用中由原来的在线编辑转为本地编辑获得了更高的自由度和效率， +除了博客，放眼到其它行业，基于文件、目录就能管理内容的典型还有代码托管（如Github）、网盘和云存储（如iCloud）， +那我们何不把这个成功的经验推广到更多的内容创作领域，如：小说、摄影、播客，帮助创作者简化将内容制作成网站的工作， +于是FileSite.io诞生了。 -为**进一步降低**内容分享者、内容创作者把内容变成网站的**门槛**， + +## 愿景 + +**进一步降低**内容分享者、创作者把内容变成网站的**门槛**， 以常见的本地磁盘目录+文件的形式作为网站数据来源， 修改磁盘文件内容上传到服务器就可以生成网页， 让大家更易于同时维护本地和网站的内容。 -目标用户： +FileSite.io希望帮助到他们： * 经常用Markdown写文档/文章的朋友 * 网址导航站经营者、收藏夹/网址分享者 * 小说网站经营者、小说创作者、博客主、作家、自媒体人 @@ -26,7 +32,22 @@ 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. 打开网址浏览最新内容； @@ -36,19 +57,28 @@ filesite使用非常简单，一旦部署好之后，以后只需将本地最新 ## 在线体验 1. 文档站 -* Filesite.io + + | 名称 | 网址 | +| ---- | ---- | +| FileSite | Filesite.io | 2. 导航站 -* 待续 + + - 3. 小说站 -* 待续 + + - 4. 图片站 -* GoogleImage.Filesite.io + + | 名称 | 网址 | +| ---- | ---- | +| 看美女 | GoogleImage.Filesite.io | 5. 视频站 -* 待续 + + - ## 源码下载 @@ -59,22 +89,51 @@ Machete是砍刀，它能砍、能削、能切、能剁，最适合披荆斩棘 Filesite.io也一样，它短小精悍，使用它把常见的本地文件制作成网站，就像拿起砍刀一样简单， 所以我们将filesite.io的源码命名为**machete**。 +点击下面网址查看源码或者下载源码： -用git下载： +* 查看filesite.io源码Machete。 + +* 用git下载： ``` git clone https://git.filesite.io/filesite/machete.git ``` -去查看filesite.io源码Machete。 - +* 还可以下载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) @@ -84,6 +143,10 @@ filesite.io二次开发参考： * [类DirScanner定义](./Class_DirScanner.md) +如果上面的手册还不能帮助解决你的问题， +请按下面方式提交反馈与建议。 + + ## 反馈与建议 待续