zavy86/wikidocs

Wiki|Docs

一个无需数据库的Markdown平面文件维基引擎。

项目主页：[***]

欢迎通过******支持本项目

核心功能与特性

• 开源
• 纯文本文件存储
• 无需数据库
• Markdown语法支持
• 完整WYSIWYG编辑器
• KaTeX数学公式支持
• 无限页面修订版本
• 附件上传与下载
• 图片上传（支持剪贴板）
• 内容可按命名空间分类
• 自动生成索引和站点地图
• 公开和私有浏览模式
• 语法高亮
• 多语言支持
• 黑暗模式
• 站点地图
• 以及更多功能...

演示

可在以下地址体验演示环境：[***]

认证码：demo

部署与使用

手动部署

https://github.com/Zavy86/wikidocs/releases%E6%9C%80%E6%96%B0%E7%89%88%E6%9C%AC%E6%88%96%E9%80%9A%E8%BF%87%60git clone https://github.com/Zavy86/wikidocs.git%60%E5%85%8B%E9%9A%86%E4%BB%93%E5%BA%93%E3%80%82

Docker部署

提供https://hub.docker.com/repository/docker/zavy86/wikidocs%EF%BC%8C%E5%8F%AF%E8%87%AA%E5%8A%A8%E9%85%8D%E7%BD%AEApache2%E5%92%8CPHP%E7%8E%AF%E5%A2%83%E3%80%82

快速启动

docker run -d -p 80:80 zavy86/wikidocs

额外设置

docker run --name wikidocs -d -p 80:80 -v /path/to/local/wikidocs/datasets/or/volume:/datasets -e PUID=1000 -e PGID=1000 zavy86/wikidocs

Docker Compose配置

yaml
version: '3'

services:
  wikidocs:
    image: zavy86/wikidocs
    environment:
      - PUID=1000
      - PGID=1000
    ports:
      - 80:80
    volumes:
      - /path/to/local/wikidocs/datasets/or/volume:/datasets

服务器配置

Apache配置

自动配置

setup.php脚本会自动创建datasets/config.inc.php和.htaccess文件。

手动配置

• 复制配置示例文件：cp config.sample.inc.php datasets/config.inc.php
• 编辑配置文件：nano datasets/config.inc.php
• 创建.htaccess文件，内容如下：

<IfModule mod_rewrite.c>
	RewriteEngine On
	RewriteBase /
	RewriteCond %{REQUEST_URI} \.md$ [NC]
	RewriteRule ^.*$ / [R=301,L]
	RewriteCond %{REQUEST_FILENAME} !-f
	RewriteRule ^(.*)$ index.php?doc=$1 [NC,L,QSA]
</IfModule>

• 确保RewriteBase与配置文件中的PATH一致，包括尾部斜杠。

Nginx配置

手动配置

• 使用以下Nginx配置：

location ~* \.(css|js|jpg|jpeg|png|gif|ico|svg)$ {
  try_files $uri =404;
  add_header Cache-Control "public, max-age=3600";
}
location ~* \.md$ {
  return 301 /;
}
location / {
  if (!-e $request_filename){
    rewrite ^/(.*)$ /index.php?doc=$1 last;
  }
  try_files $uri $uri/ =404;
}

• 复制配置示例文件：cp config.sample.inc.php datasets/config.inc.php
• 编辑配置文件：nano datasets/config.inc.php

自定义

可通过创建styles/styles-custom.css文件来自定义默认模板。

开发人员

创建者

Manuel Zavatta

• 个人网站
• https://github.com/Zavy86

• ---

• 联系方式

贡献者

• https://github.com/leomoon
• https://github.com/reyemxela
• https://github.com/serial
• https://github.com/bitwisecreative
• https://github.com/jv3ga
• https://github.com/sam-6174
• https://github.com/kevwkev
• https://github.com/vorons
• https://github.com/nicolas35380
• https://github.com/aaadonai
• https://github.com/MiguelRenato
• https://github.com/inalto
• https://github.com/dvisentin-freelance
• https://github.com/pce-consulting

许可协议

代码采用MIT许可协议发布。