diff --git a/README.md b/README.md index 483ce6e..be3518d 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,16 @@ + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理,属于社区翻译,非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/phachon/mm-wiki) · [上游 README](https://github.com/phachon/mm-wiki/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 +

![brand](./static/images/logo_sm.png)

-> 首先非常感谢大家的使用,每次看到大家的留言,感到很惭愧,最近几年没有太多精力维护,另外当初在新功能迭代的时候发现 UI 和技术栈都需要彻底的重构,所以就保持在了当前版本未继续更新。后续我决定开始计划全新版本的开发,也希望大家共同参与起来。我在5年前做这个 wiki 的初衷也是期望成为国内免费开源的最好用的wiki系统,期望可以做成和 confluence 一样伟大的产品吧。 +> 首先非常感谢大家的使用,每次看到大家的留言,感到很惭愧,最近几年没有太多精力维护,另外当初在新功能迭代的时候发现 UI 和技术栈都需要彻底的重构,所以就保持在了当前版本未继续更新。后续我决定开始计划全新版本的开发,也希望大家共同参与起来。我在5年前做这个 wiki 的初衷也是期望成为国内免费开源的最好用的 wiki 系统,期望可以做成和 Confluence 一样伟大的产品吧。
@@ -22,17 +28,17 @@ MM-Wiki 是一个轻量级的企业知识分享与团队协同软件,可用于 # 特点 - 部署方便,基于 golang 编写,只需要下载对于平台下二进制文件执行即可。 -- 快速安装程序, 提供方便的安装界面程序,无需任何手动操作。 +- 快速安装程序,提供方便的安装界面程序,无需任何手动操作。 - 独立的空间,空间是一组文档的集合,一般为公司部门或者团队,空间下的文档相互独立。空间可根据需求设置空间访问级别。 -- 支持 markdown 语法写作,支持附件上传。 +- 支持 Markdown 语法写作,支持附件上传。 - 完善的系统权限管理,系统可以自定义角色,并为不同角色授予不同的权限。 -- 集成统一登录,本系统支持通过外部系统认证用户, 比如与公司的 LDAP 登录融合。具体请看登录认证功能。 +- 集成统一登录,本系统支持通过外部系统认证用户,比如与公司的 LDAP 登录融合。具体请看登录认证功能。 - 邮件通知功能,当开启邮件通知,文档更改会通知所有关注该文档的用户。 - 文档具有分享和下载功能,目前只支持下载 MarkDown 源文件。 - 支持文档全文搜索 # 在线快速了解 -- [mm-wiki企业知识分享与团队协同软件](http://wiki.cifaz.com/), 用户名:admin, 密码:mmwiki, 点击不了请复制http://wiki.cifaz.com/ +- [mm-wiki 企业知识分享与团队协同软件](http://wiki.cifaz.com/), 用户名:admin,密码:mmwiki,点击不了请复制 http://wiki.cifaz.com/ # 安装 ## 1. 自助安装 @@ -54,7 +60,7 @@ MM-Wiki 是一个轻量级的企业知识分享与团队协同软件,可用于 # 执行安装程序,默认端口为 8090,指定其他端口加参数 --port=8087 $ ./install # 浏览器访问 http://ip:8090 进入安装界面,完成安装配置 - # Ctrl + C 停止 install 程序, 启动 MM-Wiki 系统 + # Ctrl + C 停止 install 程序,启动 MM-Wiki 系统 $ cd .. $ ./mm-wiki --conf conf/mm-wiki.conf # 浏览器访问你监听的 ip 和端口 @@ -80,20 +86,20 @@ MM-Wiki 是一个轻量级的企业知识分享与团队协同软件,可用于 - Docker 部署 ``` # 数据库准备 - # 导入docs/databases/data.sql和docs/databases/table.sql(注:需取消注释data.sql中第一条管理用户插入语句) + # 导入 docs/databases/data.sql 和 docs/databases/table.sql(注:需取消注释 data.sql 中第一条管理用户插入语句) # 两种部署方式可用 # DockerHub(推荐) - # 从DockerHub下载v0.1.7版本 - # 新增配置文件,数据存放目录以及Mysql数据库配置在mm-wiki.conf配置文件中设置 - # 挂载配置文件及数据存放目录,启动端口为8080 + # 从 DockerHub 下载 v0.1.7 版本 + # 新增配置文件,数据存放目录以及 Mysql 数据库配置在 mm-wiki.conf 配置文件中设置 + # 挂载配置文件及数据存放目录,启动端口为 8080 # docker run -d -p 8080:8081 -v /data/mm-wiki/conf/:/opt/mm-wiki/conf/ -v /data/mm-wiki/data:/data/mm-wiki/data/ --name mm-wiki eahom/mm-wiki:v0.1.7 # 本地构建最新代码 # 构建项目镜像 # docker build -t mm-wiki-image . - # 新增配置文件,数据存放目录以及Mysql数据库配置在mm-wiki.conf配置文件中设置 - # 挂载配置文件及数据存放目录,启动端口为8080 + # 新增配置文件,数据存放目录以及 Mysql 数据库配置在 mm-wiki.conf 配置文件中设置 + # 挂载配置文件及数据存放目录,启动端口为 8080 # docker run -d -p 8080:8081 -v /data/mm-wiki/conf/:/opt/mm-wiki/conf/ -v /data/mm-wiki/data/:/data/mm-wiki/data/ --name mm-wiki mm-wiki-image ``` ## 2. 如果需要,可用 nginx 配置反向代理 @@ -165,7 +171,7 @@ $ cd mm-wiki $ go build ./ ``` ->如果你想为 mm-wiki 贡献代码,请加开发者交流群:922827699 +> 如果你想为 mm-wiki 贡献代码,请加开发者交流群:922827699 ## 贡献者列表 @@ -192,8 +198,8 @@ $ go build ./ ## 反馈 - 官方 QQ 交流群:853467682 - 如果您喜欢该项目,请 [Star](https://github.com/phachon/mm-wiki/stargazers). -- 如果在使用过程中有任何问题, 请提交 [Issue](https://github.com/phachon/mm-wiki/issues). -- 如果您发现并解决了bug,请提交 [Pull Request](https://github.com/phachon/mm-wiki/pulls). +- 如果在使用过程中有任何问题,请提交 [Issue](https://github.com/phachon/mm-wiki/issues). +- 如果您发现并解决了 bug,请提交 [Pull Request](https://github.com/phachon/mm-wiki/pulls). - 如果您想二次开发,欢迎 [Fork](https://github.com/phachon/mm-wiki/network/members). - 如果你想交个朋友,欢迎发邮件给 [phachon@163.com](mailto:phachon@163.com).