在本地轻松部署 Mindoc 文档服务器，享受在线 Markdown 编辑便利

使用 Docker Compose 部署 Mindoc：打造一个强大的本地 Markdown 文档服务器

概述

技术文档编写者和团队协作需要一个可靠且易用的文档服务器。Mindoc 是一款开源 Markdown 文档服务器，提供强大的在线编辑功能，让您可以轻松创建、协作和管理文档。本教程将指导您如何在本地使用 Docker Compose 部署 Mindoc，从而享受其在线 Markdown 编辑的便利。

步骤

1. 克隆 Mindoc 存储库

首先，使用以下命令克隆 Mindoc 的 GitHub 存储库：

git clone https://github.com/hitherejoe/mindoc.git

2. 创建 Docker Compose 文件

转到克隆的 Mindoc 目录并创建一个名为 docker-compose.yml 的 Docker Compose 文件。将以下内容粘贴到文件中：

version: '3.7'

services:
  mindoc:
    image: jupyter/mindoc:latest
    container_name: mindoc
    ports:
      - 8080:8080
    volumes:
      - ./data:/mindoc/data

3. 配置 Mindoc

要配置 Mindoc，您需要创建一个配置文件 mindoc.json。此文件应放置在克隆的 Mindoc 目录中。将其内容替换为以下内容：

{
  "enableAuth": false,
  "uploadEnabled": true,
  "theme": "dark",
  "customThemes": {},
  "exportFormats": {
    "html": true,
    "pdf": true,
    "word": true,
    "slide": true
  }
}

4. 运行 Docker Compose

使用以下命令运行 Docker Compose：

docker-compose up -d

5. 访问 Mindoc

现在，您可以使用浏览器访问 Mindoc。在地址栏中输入 http://localhost:8080。您将看到 Mindoc 的登录页面。

功能

登录后，您可以使用以下功能：

• 实时预览
• 语法高亮
• 协作编辑
• 文件上传
• Markdown 和 HTML 导出

自定义

您可以通过修改 mindoc.json 配置文件来自定义 Mindoc。以下是您可用的选项：

• enableAuth : 启用或禁用身份验证
• uploadEnabled : 启用或禁用文件上传
• theme : 设置主题（浅色或深色）
• customThemes : 创建自定义主题
• exportFormats : 启用或禁用导出格式

优势

使用 Mindoc 提供以下优势：

• 轻松创建、协作和管理 Markdown 文档
• 直观的在线编辑界面
• 实时预览和语法高亮
• 可定制的主题和导出格式
• 对文件上传的支持

常见问题解答

1. 如何启用身份验证？

   编辑 mindoc.json 文件并设置 enableAuth 为 true。

2. 我可以上传哪些文件类型？

   您可以上传 .md、.markdown 和 .txt 文件。

3. 如何导出我的文档？

   单击文档右上角的“导出”按钮。

4. 如何创建自定义主题？

   编辑 mindoc.json 文件并添加一个 customThemes 条目。

5. 如何更新 Mindoc？

   运行以下命令：

   docker-compose pull
   docker-compose up -d
   

结论

通过使用 Docker Compose 部署 Mindoc 文档服务器，您可以在本地享受在线 Markdown 编辑的便利。Mindoc 提供了强大的功能，使您能够轻松地创建、协作和管理文档。利用本指南中的步骤，您可以快速启动并运行 Mindoc，并将其集成到您的技术文档工作流程中。