MarkdownBrain

MarkdownBrain 是一个开源的数字花园构建工具，可以无缝集成 Obsidian 知识库。它采用客户端-服务器架构，让您能够安全地在线发布和分享您的 Markdown 笔记。通过简单的配置和 Docker 支持，您可以快速搭建自己的知识分享平台。

主要特点：

• 直接集成 Obsidian 知识库
• 支持 Docker 快速部署
• 安全的 API 密钥认证
• 可自定义配置
• 支持云存储（iCloud）

自托管

系统要求：

• Docker（用于运行服务器）
• 命令行工具
• Obsidian 笔记库（可选）

服务器端配置

1. 创建服务器配置文件

首先，我们需要创建一个 config.yml 文件来配置服务器：

echo 'lang: "en"
root_note_name: "Welcome"
name: "MarkdownBrain"
description: "MarkdownBrain"
api_key: "1234567890"' > config.yml

配置参数说明：

• lang: 系统语言，目前设置为英语
• root_note_name: 根笔记的名称
• name: 站点名称
• description: 站点描述
• api_key: API 密钥，用于客户端认证

2. 启动服务器

使用 Docker 运行服务器：

docker run -dit --name markdownbrain \
    -v $(pwd)/config.yml:/markdownbrain/config.yml \
    -p 3000:3000 \
    ghcr.io/blackstorm/markdownbrain-server:latest

服务器将在本地的 3000 端口运行。

客户端配置

1. 创建客户端配置文件

创建一个 config.yml 文件：

echo 'source: "~/Library/Mobile Documents/com~apple~CloudDocs/obsidian/example"
server: "https://your-server-url"
api_key: "1234567890"
ignores:
  - "Templates"' > config.yml

配置参数说明：

• source: 笔记库路径（如果使用 Obsidian，这里填写 vault 的路径）
• server: 服务器地址
• api_key: 需要与服务器配置中的 API 密钥保持一致
• ignores: 需要忽略的文件夹列表

2. 下载并运行客户端

1. 下载客户端程序：

curl -L https://github.com/blackstorm/markdownbrain/releases/download/v0.1.1/markdownbrain-cli-darwin-amd64 -o markdownbrain-client

2. 添加执行权限：

chmod +x markdownbrain-client

3. 运行客户端：

./markdownbrain-client -c config.yml

注意事项

1. 在启动客户端之前，请确保服务器已经正常运行
2. 确保客户端和服务器的 API 密钥一致
3. 如果使用 Obsidian，请确保正确配置了 vault 路径
4. 建议将模板文件夹（Templates）添加到忽略列表中

工作流程

1. 首先启动服务器端
2. 配置并运行客户端
3. 客户端会监控指定文件夹的变化，并将更改同步到服务器
4. 可以通过服务器提供的 Web 界面访问你的数字花园

运作原理

MarkdownBrain 为维护你的数字花园创建了一个无缝的工作流程：

1. 内容创作：用 Markdown 格式编写笔记（兼容 Obsidian）
2. 自动同步：客户端自动检测变更并同步到服务器
3. 网页访问：通过整洁的 Web 界面访问你的笔记
4. 组织管理：保持笔记结构和链接的完整性

按照这些步骤，你可以轻松地使用 MarkdownBrain 将你的笔记转换为可访问的在线知识库。系统会维护你的笔记连接的完整性，同时为你的数字花园提供一个面向公众的界面。

下一步

接入统计和分析工具
使用 CDN 加载 HTMX 脚本

链接

数字花园是什么

其他语言

• MarkdownBrain

Last updated: 2025-01-08.