OtterWiki 开源项目教程

1. 项目介绍

OtterWiki 是一个基于 Python 的极简主义 Wiki 系统，适用于协作内容管理。它使用 Markdown 作为标记语言，内容存储在 Git 仓库中，能够跟踪所有更改。OtterWiki 使用 Flask 作为微框架，halfmoon 作为 CSS 框架，CodeMirror 作为编辑器，Font Awesome Free 提供图标。

主要特点

• 极简界面：支持暗模式。
• Markdown 编辑器：支持 Markdown 高亮显示和表格。
• 完整变更日志和页面历史。
• 用户认证。
• 页面附件。
• 可爱的 Otter 图标（由 Christy Presler 绘制，CC BY 3.0）。

2. 项目快速启动

使用 Docker-Compose 快速启动

1. 创建 docker-compose.yml 文件：

   version: '3'
   services:
     otterwiki:
       image: redimp/otterwiki:2
       restart: unless-stopped
       ports:
         - 8080:80
       volumes:
         - ./app-data:/app-data
   

2. 启动 OtterWiki：

   docker-compose up -d
   

3. 访问 OtterWiki： 打开浏览器，访问 http://127.0.0.1:8080。

4. 注册管理员账户： 首次访问时，注册一个管理员账户，该账户将有权访问设置选项卡。

自定义设置

在设置选项卡中，根据需要自定义 OtterWiki 的配置。详细配置指南请参考官方文档。

3. 应用案例和最佳实践

应用案例

• 团队知识库：OtterWiki 可以作为团队内部的知识库，存储项目文档、技术文档和团队规范。
• 个人笔记：个人用户可以使用 OtterWiki 作为个人笔记系统，记录学习笔记、工作笔记等。
• 开源项目文档：开源项目可以使用 OtterWiki 作为项目文档的管理系统，方便开发者协作和版本控制。

最佳实践

• 定期备份：由于 OtterWiki 的内容存储在 Git 仓库中，建议定期备份 Git 仓库以防止数据丢失。
• 权限管理：根据团队需求，合理设置用户权限，确保内容的安全性和可访问性。
• 使用 Markdown：充分利用 Markdown 的语法特性，使文档结构清晰、易于阅读。

4. 典型生态项目

相关项目

• Flask：OtterWiki 使用 Flask 作为后端框架，Flask 是一个轻量级的 Python Web 框架。
• halfmoon：OtterWiki 使用 halfmoon 作为 CSS 框架，提供响应式设计和暗模式支持。
• CodeMirror：OtterWiki 使用 CodeMirror 作为 Markdown 编辑器，支持语法高亮和代码编辑。
• Font Awesome：OtterWiki 使用 Font Awesome 提供图标支持，增强界面视觉效果。

集成项目

• GitLab/GitHub：可以将 OtterWiki 与 GitLab 或 GitHub 集成，利用其强大的版本控制和协作功能。
• Nginx/Apache：通过配置 Nginx 或 Apache 作为反向代理，可以提高 OtterWiki 的性能和安全性。

通过以上模块的介绍，您可以快速了解 OtterWiki 的功能和使用方法，并根据实际需求进行部署和配置。