介绍

  • CodeX Docs 是一个免费的文档应用程序。它基于Editor.js生态系统，为处理内容提供了所有现代机会。

  • 您可以将其用于产品文档、内部团队文档、个人笔记或任何其他需求。

  • 它非常易于安装和使用。

功能特点

  • CodeX Docs利用Editor.js作为编辑引擎，为用户提供了丰富的功能和工具，使文档创建和编辑变得简单而愉快。以下是一些主要功能：

  • • 🤩 Editor.js驱动：CodeX Docs使用Editor.js作为其编辑引擎，使用户能够以直观的方式创建和编辑文档内容。

  • • 📂 文档嵌套：CodeX Docs支持文档的嵌套结构，您可以根据需要创建任何层次的结构，方便组织和管理大量文档。

  • • 📱 响应式设计：CodeX Docs在桌面和移动设备上都具有出色的外观和用户体验，无论您在哪种设备上使用，都能获得一致的界面。

  • • 🔥 优美的页面URL：CodeX Docs生成人类可读且友好的页面URL，这对于SEO和用户体验都非常有益。

  • • 📈 集成的Yandex Metrica：CodeX Docs集成了Yandex Metrica，这是一个强大的网站分析工具，可以帮助您了解文档的访问量、用户行为等重要数据。

  • • 🚢 简单部署：CodeX Docs无需复杂的数据库或其他依赖项，您可以轻松地部署和运行它，省时省力。

  • • 🤙 简单配置：CodeX Docs提供简单的配置选项，您可以根据需要调整用户界面，折叠部分内容、隐藏侧边栏等。

安装教程

docker-compose方式安装

  1. 演示以在群晖NAS系统上安装为例
    （其他系统请自行安装好最新版本Docker、docker-compose）

  2. 在群晖套件中心安装Node.js v20（官方文档要求使用的Node.js不低于Node.js v16作为依赖。）
    （可选安装，在网络教程中未发现他人按照官方要求进行安装依赖，建议安装，也可不装。）

  3. 打开群晖的SSH功能，使用终端软件进行连接，并切换到root状态下。

  4. 进入群晖的docker文件夹（你想将容器数据存储到哪就进哪个文件夹）

    cd /volume1/docker

  5. 创建项目文件夹及子文件夹

    # uploads是上传文件夹
# db是数据库文件夹

mkdir -p docs/{uploads,db}

  6. 进入项目文件夹

    cd docs

  7. 编辑docker-compose.yml文件

    vi docker-compose.yml

  8. 按字母 i 键进入编辑模式，复制并修改下面的配置文件，粘贴到终端，按Esc键退出编辑模式，输入 :wq 退出并保存。