动态

详情 返回 返回

簡單好用!一款針對 IT 團隊開發的文檔管理系統! - 动态 详情

大家好,我是 Java陳序員

在 IT 團隊協作中,接口文檔散亂、版本混亂、權限管理複雜等問題常常困擾着 IT 從業者。

今天,為大家推薦一款簡單好用的文檔管理系統,尤其適合 IT 中小團隊高效管理各類文檔!

關注微信公眾號:【Java陳序員】,獲取開源項目分享、AI副業分享、超200本經典計算機電子書籍等。

項目介紹

MinDoc —— 一款針對 IT 團隊開發的文檔管理系統,基於 Golang 開發,內置項目管理,用户管理,權限管理等功能,可以用來儲存日常接口文檔,數據庫字典,手冊説明等文檔。

功能特色

  • 項目空間劃分:支持創建多個項目空間,每個空間可獨立管理文檔,適合多團隊或多產品線並行管理
  • 性化項目設置:支持配置項目名稱、描述、評論權限、自動發佈、下載權限等,適配不同項目需求
  • 多編輯器支持:兼容 Markdown、CherryMarkdown、HTML 等多種編輯器,滿足不同項目團隊的編輯習慣,切換編輯器時會自動校驗兼容性,避免格式錯亂
  • 版本與歷史管理:自動記錄文檔修改歷史,支持設置歷史版本保留數量,便於追溯變更記錄
  • 精細的權限劃分:通過用户角色(管理員、編輯者、觀察者)區分操作權限,非管理員僅能修改自己創建的文檔,確保文檔修改、查看權限可控
  • 導出與分享:支持將項目文檔導出為 PDF、EPUB、MOBI、DOCX 等格式,導出時自動生成封面、目錄和樣式,保留原文檔排版;支持通過鏈接快速分享文檔,同時保護敏感內容
  • 輕量部署:基於 Golang 開發,部署簡單,無需複雜依賴;支持 Docker 部署,進一步簡化環境配置;同時支持 MySQL 和 SQLite 數據庫,數據存儲穩定

安裝部署

Windows 環境部署

1、下載最新版的可執行文件 mindoc_windows_${操作系統}.7z 並解壓

https://github.com/mindoc-org/mindoc/releases

2、創建數據庫(可跳過)

如果使用 MySQL 數據庫,請創建一個編碼為 utf8mb4 格式的數據庫

CREATE DATABASE mindoc_db  DEFAULT CHARSET utf8mb4 COLLATE utf8mb4_general_ci;

3、配置數據庫

將解壓目錄下的 conf/app.conf.example 配置文件重名為 app.conf, 並配置數據庫信息。

  • 如使用的是 MySQL 數據庫,參考如下配置修改正確的數據庫連接信息:
## 數據庫配置
db_adapter=mysql

## MySQL 數據庫的 IP
db_host=127.0.0.1

## MySQL 數據庫的端口號一般為3306
db_port=3306

## 剛才創建的數據庫的名稱
db_database=mindoc_db

## 訪問數據庫的賬號和密碼
db_username=root
db_password=123456

然後,在 MinDoc 根目錄下使用命令行執行如下命令,用於初始化數據庫:

mindoc_windows_amd64.exe install
  • 如使用的是 sqlite 數據庫,將 conf/app.conf 中的數據庫配置成如下,系統會自動創建 sqlite 數據庫文件:
db_adapter=sqlite3
db_database=mindoc_db

4、啓動程序

在 CMD 命令行啓動 mindoc_windows_amd64.exe 程序

5、運行成功後,瀏覽器訪問

http://localhost:8181

超級管理員賬號:admin 密碼:123456.

Linux 環境部署

1、下載最新版的可執行文件 mindoc_linux_${操作系統}.zip

https://github.com/mindoc-org/mindoc/releases

2、解壓壓縮包

tar -xzvf mindoc_linux_amd64.tar.gz
或
unzip mindoc_linux_amd64.zip

3、創建數據庫(可跳過)

如果使用 MySQL 數據庫,請創建一個編碼為 utf8mb4 格式的數據庫

CREATE DATABASE mindoc_db  DEFAULT CHARSET utf8mb4 COLLATE utf8mb4_general_ci;

4、配置數據庫

將解壓目錄下的 conf/app.conf.example 配置文件重名為 app.conf, 並配置數據庫信息:

cp conf/app.conf.example conf/app.conf
  • 如使用的是 MySQL 數據庫,參考如下配置修改正確的數據庫連接信息:
## 數據庫配置
db_adapter=mysql

## MySQL 數據庫的 IP
db_host=127.0.0.1

## MySQL 數據庫的端口號一般為 3306
db_port=3306

## 剛才創建的數據庫的名稱
db_database=mindoc_db

## 訪問數據庫的賬號和密碼
db_username=root
db_password=123456

然後,在 MinDoc 根目錄下使用命令行執行如下命令,用於初始化數據庫:

./mindoc_linux_amd64 install
  • 如使用的是 sqlite 數據庫,將 conf/app.conf 中的數據庫配置成如下,系統會自動創建 sqlite 數據庫文件:
db_adapter=sqlite3
db_database=mindoc_db

5、啓動程序

## 修改可執行權限
chmod +x mindoc_linux_amd64

## 啓動程序
./mindoc_linux_amd64

6、運行成功後,瀏覽器訪問

http://{ip/域名}:8181

超級管理員賬號:admin 密碼:123456.

Docker 環境部署

1、創建掛載目錄

## 創建配置文件掛載目錄
mkdir -p /data/software/mindoc/conf

## 創建數據庫掛載目錄(如使用 MySQL 數據庫可忽略)
mkdir -p /data/software/mindoc/data

## 創建文件上傳掛載目錄
mkdir -p /data/software/mindoc/uploads

2、一鍵啓動

docker run -it \
  --name=mindoc \
  --restart=always \
  -v /data/software/mindoc/conf/conf:/mindoc/conf \
  -v /data/software/mindoc/conf/data:/mindoc/database \
  -v /data/software/mindoc/conf/uploads:/mindoc/uploads \
  -p 8181:8181 \
  -e MINDOC_ENABLE_EXPORT=true \
  -d registry.cn-hangzhou.aliyuncs.com/mindoc-org/mindoc:v2.1

如使用 MySQL 數據庫,可修改 conf/app.conf 中的數據庫配置(參考前文),當修改配置文件後,重啓容器即可。

3、容器啓動成功後,瀏覽器訪問

http://{ip/域名}:8181

超級管理員賬號:admin 密碼:123456.

4、配置代理(可選)

如果你不想用默認端口號訪問 Mindoc, 可使用 Nginx 進行反向代理,配置文件如下:

server {
    listen       80;

    #此處應該配置你的域名:
    server_name  chencoding.top;

    charset utf-8;

    #此處配置你的訪問日誌,請手動創建該目錄:
    access_log  /var/log/nginx/webhook.iminho.me/access.log;

    location / {
        try_files /_not_exists_ @backend;
    }

    # 這裏為具體的服務代理配置
    location @backend {
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_set_header Host            $http_host;
        proxy_set_header   X-Forwarded-Proto $scheme;

        #此處配置 MinDoc 程序的地址和端口號
        proxy_pass http://127.0.0.1:8181;
    }
}

功能體驗

前台

  • 首頁

  • 項目管理

  • 文檔

  • 文章

管理後台

  • 儀表盤

  • 項目管理

  • 配置管理

MinDoc 專注於文檔的創建、管理與協作,無論是初創團隊的接口文檔管理、中小企業的知識庫搭建,還是部門內部的手冊共享,MinDoc 都能完美勝任工作。快去安裝試試吧~

項目地址:https://github.com/mindoc-org/mindoc

最後

推薦的開源項目已經收錄到 GitHub 項目,歡迎 Star

https://github.com/chenyl8848/great-open-source-project

或者訪問網站,進行在線瀏覽:

https://chencoding.top:8090/#/

我創建了一個開源項目交流羣,方便大家在羣裏交流、討論開源項目

但是任何人在羣裏打任何廣告,都會被 T 掉

如果你對這個交流羣感興趣或者在使用開源項目中遇到問題,可以通過如下方式進羣

關注微信公眾號:【Java陳序員】,回覆【開源項目交流羣】進羣,或者通過公眾號下方的菜單添加個人微信,並備註【開源項目交流羣】,通過後拉你進羣

大家的點贊、收藏和評論都是對作者的支持,如文章對你有幫助還請點贊轉發支持下,謝謝!


user avatar vanve 头像 kobe_fans_zxc 头像 ayuan01 头像 xiaoxxuejishu 头像 bugDiDiDi 头像 tanggoahead 头像 youyoufei 头像 buildyuan 头像 wnhyang 头像 jungang 头像 aitibao_shichangyingxiao 头像 zhedan_sam_wan9 头像
点赞 66 用户, 点赞了这篇动态!
点赞

Add a new 评论

Some HTML is okay.