From a6171b56ef33fd44d23380c189d02dc4c3e2b3b6 Mon Sep 17 00:00:00 2001 From: filesite Date: Fri, 8 Apr 2022 22:28:53 +0800 Subject: [PATCH] Readme update --- Class_DirScanner.md | 2 +- README.md | 32 ++++++++++++++++++++++++-------- 2 files changed, 25 insertions(+), 9 deletions(-) diff --git a/Class_DirScanner.md b/Class_DirScanner.md index d092c44..9dc1cb1 100644 --- a/Class_DirScanner.md +++ b/Class_DirScanner.md @@ -81,4 +81,4 @@ Nginx防盗链MD5加密方式参考下面网址中的示例， {secure_link_expires}{uri}{remote_addr} {secret} ``` -* http://nginx.org/en/docs/http/ngx_http_secure_link_module.html#secure_link_md5 +* Nginx secure link module diff --git a/README.md b/README.md index 21364ae..9044c7d 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,18 @@ -# filesite.io - 无数据库、基于文件和目录的网址导航、图书、图片、视频网站PHP开源系统 +# filesite.io - 无数据库、基于文件和目录的Markdown文档、网址导航、图书、图片、视频网站PHP开源系统 ## 简介 -项目名称：filesite.io +项目名称：**filesite.io** 项目介绍： -为进一步降低内容分享者、内容创作者把内容变成网站的门槛， + +为**进一步降低**内容分享者、内容创作者把内容变成网站的**门槛**， 以常见的本地磁盘目录+文件的形式作为网站数据来源， 修改磁盘文件内容上传到服务器就可以生成网页， 让大家更易于同时维护本地和网站的内容。 目标用户： +* 经常用Markdown写文档/文章的朋友 * 网址导航站经营者、收藏夹/网址分享者 * 小说网站经营者、小说创作者、博客主、作家、自媒体人 * 图片网站经营者、摄影师、摄影爱好者、驴友 @@ -22,9 +24,9 @@ filesite使用非常简单，一旦部署好之后，以后只需将本地最新内容上传覆盖即可。 -1. 下载filesite源码，并参考文档部署到你的服务器上； -2. 修改配置文件config/app.php，简单设置后上传到服务器完成部署； -3. 将本地内容目录及文件上传到网站目录：content/ +1. 下载filesite源码，并参考[Nginx配置参考](./Nginx.conf.md)部署到你的服务器上； +2. 修改配置文件``config/app.php``，简单设置后上传到服务器完成部署； +3. 将本地内容目录及文件上传到网站目录：``www/content/`` 4. 打开网址浏览最新内容； 有了filesite，你可以保留现有的本地内容创作习惯，并非常容易地把它们制作成一个网站分享给他人。 @@ -42,7 +44,14 @@ Machete是砍刀，它能砍、能削、能切、能剁，最适合披荆斩棘 Filesite.io也一样，它短小精悍，使用它把常见的本地文件制作成网站，就像拿起砍刀一样简单， 所以我们将filesite.io的源码命名为**machete**。 -见[filesite.io源码Machete](https://git.filesite.io/filesite/machete) + +用git下载： +``` +git clone https://git.filesite.io/filesite/machete.git +``` + +去查看filesite.io源码Machete。 + ## 皮肤下载 @@ -51,7 +60,14 @@ Filesite.io也一样，它短小精悍，使用它把常见的本地文件制作 ## 使用手册 -见[filesite.io使用手册](./Manual.md) +filesite.io核心代码参考： +* [Filesite.io core lib](./FSC.md) +* [Nginx配置参考](./Nginx.conf.md) + +filesite.io二次开发参考： +* [filesite.io使用手册](./Manual.md) +* [类DirScanner定义](./Class_DirScanner.md) + ## 反馈与建议