docs: docs for sharelsit-next

li9769006 · Oct 14, 2021 · fbc73c4 · fbc73c4
1 parent c8ee9e6
commit fbc73c4
Show file tree

Hide file tree

Showing 16 changed files with 198 additions and 1 deletion.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -19,7 +19,7 @@ body:
       description: Sharelist Version
       options:
         - v0.1
-        - v0.2
+        - latest
     validations:
       required: true
   - type: textarea

diff --git a/README.md b/README.md
@@ -5,6 +5,9 @@
 ShareList 是一个易用的网盘工具，支持快速挂载 GoogleDrive、OneDrive ，可通过插件扩展功能。  
 新版正在开发中，欢迎[提交反馈](https://github.com/reruin/sharelist/issues/new/choose)。[查看旧版](https://github.com/reruin/sharelist/tree/0.1)。
 
+## 文档
+[查看文档](https://reruin.github.io/sharelist/docs/#/zh-cn/)
+
 ## 进度
 - [x] 核心库支持 
 - [x] 新主题 

diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,13 @@
+# ShareList
+
+[![Build Status](https://github.com/reruin/sharelist/actions/workflows/ci.yml/badge.svg)](https://github.com/reruin/sharelist/actions/workflows/ci.yml)
+
+## Introduction
+ShareList is an easy-to-use netdisk tool which supports that quickly mount GoogleDrive and OneDrive, and extends functions with plugins.
+
+## Documentation
+Check out [docs](https://reruin.github.io/sharelist/#/en/).
+
+## License
+[Apache-2](http://www.apache.org/licenses/LICENSE-2.0)
+Copyright (c) 2018-present, Reruin
diff --git a/docs/_navbar.md b/docs/_navbar.md
@@ -0,0 +1,3 @@
+- Translations
+  - [:uk: English](/)
+  - [:cn: 中文](/zh-cn/)
diff --git a/docs/en/README.md b/docs/en/README.md
@@ -0,0 +1,13 @@
+# ShareList
+
+[![Build Status](https://api.travis-ci.com/reruin/sharelist.svg?branch=master)](https://travis-ci.com/reruin/sharelist)
+
+## Introduction
+ShareList is an easy-to-use netdisk tool which supports that quickly mount GoogleDrive and OneDrive, and extends functions with plugins.
+
+## Documentation
+Check out [docs](https://reruin.github.io/sharelist/#/en/).
+
+## License
+[Apache-2](http://www.apache.org/licenses/LICENSE-2.0)   
+Copyright (c) 2018-present, Reruin
diff --git a/docs/en/_navbar.md b/docs/en/_navbar.md
@@ -0,0 +1,3 @@
+- Translations
+  - [中文](/zh-cn/)
+  - [English](/en/)
diff --git a/docs/en/_sidebar.md b/docs/en/_sidebar.md
@@ -0,0 +1,3 @@
+* [Installation](en/installation.md)
+* [Configuration](en/configuration.md)
+* [Advance](en/advance.md)
diff --git a/docs/en/installation.md b/docs/en/installation.md
@@ -0,0 +1,3 @@
+# Installation
+
+Translation needed!
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,51 @@
+<!DOCTYPE html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8">
+  <title>ShareList Docs</title>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+  <meta name="description" content="Description">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <!-- <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css"> -->
+  <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/vue.css">
+  <style type="text/css">
+  .sidebar ul li.active>a {
+    border-right: none;
+  }
+  </style>
+</head>
+
+<body>
+  <div id="app"></div>
+  <script>
+  window.$docsify = {
+    name: 'ShareList',
+    repo: 'https://github.com/reruin/sharelist',
+    basePath:
+    'https://raw.githubusercontent.com/reruin/sharelist/master/docs/',
+    loadSidebar: true,
+    loadNavbar: true,
+    autoHeader: true,
+    subMaxLevel: 2,
+    search: {
+      placeholder: {
+        '/zh-cn/': '搜索',
+        '/en/': 'Search',
+      },
+      noData: {
+        '/zh-cn/': '找不到结果',
+        '/en/': 'noData',
+      },
+    },
+    nameLink: {
+      '/zh-cn/': '#/zh-cn/',
+      '/en/': '#/en/',
+    },
+  }
+  </script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
+  <script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
+</body>
+
+</html>
diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md
@@ -0,0 +1,10 @@
+# ShareList
+
+[![Build Status](https://github.com/reruin/sharelist/actions/workflows/ci.yml/badge.svg)](https://github.com/reruin/sharelist/actions/workflows/ci.yml)
+
+## 介绍
+ShareList 是一个易用的网盘工具，支持快速挂载 GoogleDrive、OneDrive ，可通过插件扩展功能。
+
+## 许可
+[Apache-2](http://www.apache.org/licenses/LICENSE-2.0)   
+Copyright (c) 2018-present, Reruin
diff --git a/docs/zh-cn/_navbar.md b/docs/zh-cn/_navbar.md
@@ -0,0 +1,3 @@
+- Translations
+  - [中文](/zh-cn/)
+  - [English](/en/)
diff --git a/docs/zh-cn/_sidebar.md b/docs/zh-cn/_sidebar.md
@@ -0,0 +1,3 @@
+* [安装](zh-cn/installation.md)
+* [后台配置](zh-cn/configuration.md)
+* [高级用法]](zh-cn/advance.md)
diff --git a/docs/zh-cn/advance.md b/docs/zh-cn/advance.md
@@ -0,0 +1,39 @@
+## 目录加密
+在需加密目录内新建 ```.passwd``` 文件（此项可修改），```type```为验证方式，```data```为验证内容。  
+例如：    
+```yaml
+type: basic
+data:
+  - 123456
+  - abcdef
+``` 
+
+可使用密码```123456```，```abcdef```验证。
+
+***
+
+## Nginx(Caddy)反向代理
+使用反代时，请添加以下配置。  
+
+#### Nginx  
+```ini 
+  proxy_set_header Host  $host;
+  proxy_set_header X-Real-IP $remote_addr;
+  proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+  proxy_set_header X-Forwarded-Proto $scheme;
+
+  proxy_set_header Range $http_range;
+  proxy_set_header If-Range $http_if_range;
+  proxy_no_cache $http_range $http_if_range;
+```   
+如果使用上传功能，请调整 nginx 上传文件大小限制。   
+```
+  client_max_body_size 8000m;
+```   
+#### Caddy   
+```ini
+  header_upstream Host {host}
+  header_upstream X-Real-IP {remote}
+  header_upstream X-Forwarded-For {remote}
+  header_upstream X-Forwarded-Proto {scheme}
+```
diff --git a/docs/zh-cn/configuration.md b/docs/zh-cn/configuration.md
@@ -0,0 +1,37 @@
+# 后台管理
+访问 ```http://localhost:33001/manage```，填写口令即可进入后台管理。
+
+## 常规
+
+### 后台管理
+设置后台管理密码。默认 ```sharelist```。
+
+### 网站标题
+设置网站标题。
+
+### 目录索引
+默认启用。如果只提供下载功能，可禁用此项。
+
+### 展开单一挂载盘
+默认启用。如果只有一个挂载盘，将默认展开。
+
+### 允许下载
+默认启用。
+
+### 忽略路径
+设置禁止访问的目录/文件路径。支持 [gitignore](http://git-scm.com/docs/gitignore) 表达式
+
+### 加密文件名
+默认```.passwd```，修改此项自定义加密文件名。
+
+### WebDAV 路径
+WebDAV路径。
+
+### WebDAV 代理
+默认启用。
+
+### WebDAV 用户
+默认 ```admin```。
+
+### WebDAV 密码
+默认 ```sharelist```。
diff --git a/docs/zh-cn/installation.md b/docs/zh-cn/installation.md
@@ -0,0 +1,13 @@
+# 安装
+Sharelist支持多种安装方式。
+
+## Docker
+```bash
+docker run -d -v /etc/sharelist:/sharelist/cache -p 33001:33001 --name="sharelist" reruin/sharelist:next
+```
+
+## 二进制版
+[release](https://github.com/reruin/sharelist/releases)下载二进制版。
+
+
+安装完成首次访问 `http://localhost:33001`地址，将进入默认界面。访问`http://localhost:33001/@manage` 进入后台管理，默认口令为 ```sharelist```。