README

在此处查看演示 DocketWiki

• 关于
• 如何使用
  • 入门
  • 要求
  • 安装
  • DocketWiki的文件、目录和结构
  • 配置
    • 配置结构
    • 主要设置
    • 侧边栏导航设置
      • 子标题项
      • 菜单项
• 元素
  • 标题
  • 文本和其他
    • 段落
    • 引用块
    • 代码块
    • 链接
    • 脚注
    • 列表
      • 无序列表
      • 有序列表
      • 嵌套列表
  • 表格
  • 图片
  • 警报
  • 手风琴
  • 图标

关于

DocketWiki是您项目或知识库的简单静态文档

DocketWiki基于MD文件，无需数据库

您不需要强大的服务器、数据库和复杂的设置即可开始

下载存档，上传并在您的服务器上解压缩。就这样

基于ParseDown和ParseDown Extra，由Emanuil Rusev提供

完全支持HTML标签和Markdown

如何使用

入门

在开始之前，请检查要求页面

要求

DocketWiki有一些系统要求。

您应确保您的Web服务器具有以下最低PHP版本和扩展

• PHP >= 7.0
• Fileinfo PHP扩展
• JSON PHP扩展
• 无需数据库！

安装

将.zip文件解压缩到您的Web服务器文件夹中。

就是这样！

DocketWiki的文件、目录和结构

• 文件夹包含项目的自定义样式、脚本、图片和其他资源
  • 文件夹包含样式
  • 文件夹包含自定义JavaScript文件
  • 文件夹包含收藏夹图标
  • 文件夹包含菜单图标
• 文件夹包含所有您的MD文件
  • 文件夹包含错误页面的模板
• 文件夹包含项目类
• 文件夹包含额外的第三方库
• 文件夹包含视图模板
  • 文件夹包含侧边栏视图
  • 文件夹包含主要视图
• 所有项目的入口点
• Web服务器的规则和条件
• 配置文件
• 配置文件的附加示例

配置

您的DocketWiki的所有设置都放置在根文件夹中的config.json上

您可以使用此演示的config.json或重命名config_example.json并放置您的更改。

配置结构

配置包含

• 主要Wiki设置
• 侧边栏导航设置

主要设置

设置的第一块包含以下代码

"version": "1.0.0",
"wiki_name": "DocketWiki",
"wiki_root_url": "/wiki/",
"start_page": "about",

是

• 您的Wiki
• 您的Wiki的名称
• 如果它是根文件夹，请放置'/'，如果是现有网站的子文件夹，请放置'/%E7%9B%AE%E5%BD%95%E5%90%8D/%/'
• 放置您的Wiki的起始URL

侧边栏导航设置

侧边栏导航设置包含一个包含所有菜单项的数组，如下所示

"sidebar":{
   "menu":[
      {
         "type":"link",
         "icon":"icon1",
         "name":"About",
         "url":"about"
      },
      {
         "type":"subtitle",
         "name":"How To"
      },
      {
         "type":"link",
         "icon":"icon1",
         "name":"Getting Started",
         "url":"how_to/getting_started"
      }
    ]
  }

是

• - 侧边栏设置的根节点。必需。
• - 菜单设置的根节点。必需。
• 可以是两种类型：带图标、文本和气泡或子标题文本的简单菜单项

子标题项

子标题项 - 没有链接、图标等的简单文本

{
   "type":"subtitle",
   "name":"How To"
}

• - 项的类型。必需。
• - 项的文本。必需。

菜单项

菜单项 - DocketWiki页面的链接

{
   "type":"link",
   "icon":"icon1",
   "name":"Getting Started",
   "url":"how_to/getting_started",
   "bubble": "success",
   "bubble_text": "some text"
}

• - 项的类型。必需。
• - 项的图标。您可以在DocketWiki的图标页面中选择图标
• - 项的文本。必需。
• - 项的URL链接。必需。
• - 项的气泡类型。可以是成功、警告、危险、信息和无操作
• - 项的气泡文本。

元素

标题

# Heading H1
## Heading H2
### Heading H3
#### Heading H4
##### Heading H5
###### Heading H6

文本和其他

段落

您可以通过在文本行之间留空行来创建新的段落。

文本样式

以下是你需要的文本主要样式

引用块

如何使用

> 重要的或不重要的内容

代码块

要将代码或文本格式化为独立的区块，请使用三个反引号

  ``` Place your code here ```

链接

如何使用

[link text](link url)

脚注

如何使用

Some text with footnote[^1].
Do not forget[^2] place the footnote!  

列表

无序列表

- List item 1
- List item 2
- List item 3

有序列表

1. List item 1
2. List item 2
3. List item 3

嵌套列表

你可以创建嵌套列表

1. First list item
   - First nested list item
     - Second nested list item

表格

标准表格使用方法如下

| Worker   | Salary  |
| ---      | ---     |
| James    | 1 200 $ |
| Anton    | 1 440 $ |

图片

如何使用

![There is an image](https://i.imgur.com/j6EIdA4.png)

警报

DocketWiki存在一些自定义警报

示例

<p class="notice notice--info">
Notice Text
</p>

可用的通知类型

手风琴

如果你想要将某些内容隐藏在可折叠面板中，你可以放置以下代码

<details>

  <summary>Accordeon: Show and Hide</summary>

  Some hided content

</details>

图标

DocketWiki使用Feather图标包来美化你的侧边菜单

HTML标签

DocketWiki完全支持自定义HTML标签

你可以放置如下内容

<a href="#url">Custom a-tag link</a>