Oracolo 开源项目教程

Oracolo 开源项目教程

oracolo A minimalist Nostr blog that consists of a single html file 项目地址: https://gitcode.com/gh_mirrors/or/oracolo

1. 项目介绍

Oracolo 是一个极简主义的 Nostr 博客，由一个单一的 HTML 文件组成，大小仅为约 140KB。它允许用户使用支持长格式（如 habla、news、yakihonne、highlighter.com 等）的 Nostr 客户端来撰写文章，并且用户的个人博客会自动更新。Oracolo 还支持在没有 Web 服务器的情况下运行，例如可以通过电子邮件发送作为名片使用。

2. 项目快速启动

开发者模式

1. 打开 index.html 文件，并将作者元标签个性化为你的 npub。
2. 运行以下命令安装依赖：

   npm install
   

3. 运行以下命令构建项目：

   npm run build
   

4. 部署生成的 dist/index.html 文件。

"I hate npm" 模式

1. 直接打开 dist/index.html 文件，并将作者元标签个性化为你的 npub。
2. 保存文件并部署。

可选设置

在 index.html 中，除了 npub 元标签外，还可以配置以下可选元标签：

• relays：设置自定义中继列表。
• top-notes：在带有封面图像的盒式格式中显示 N 条笔记，设置为 zero 以禁用。
• short-notes：将短笔记显示为轮播（值为 carousel）或在主 feed 中显示（值为 main），留空以禁用。
• short-notes-min-chars：为 short-notes 设置显示短笔记的最小字符数，设置为 zero 以禁用。
• short-notes-summary-max-chars：在 feed 中显示的短笔记预览的字符大小，设置为 zero 以显示完整内容。
• topics：允许用户按主题导航，通过标签过滤文章，留空以禁用。
• comments：在文章底部启用评论，支持 NIP-7 + NIP-46 登录。

3. 应用案例和最佳实践

应用案例

• OpenSats：使用 Oracolo 生成的博客展示了如何将 Nostr 博客集成到现有的开源项目中。
• Hodlbod：通过 Oracolo，Hodlbod 提供了一个极简的博客解决方案，适合快速部署和更新。
• fiatjaf：利用 Oracolo 的单文件特性，fiatjaf 展示了如何在 Nostr 生态系统中轻松创建和维护博客。

最佳实践

• 个性化配置：根据需求调整 index.html 中的元标签，以优化博客的显示和功能。
• 定期更新：使用 Nostr 客户端定期更新博客内容，确保信息及时性和准确性。
• 社区互动：通过启用评论功能，鼓励社区成员参与讨论和反馈。

4. 典型生态项目

• Nostr：Oracolo 是基于 Nostr 协议构建的，Nostr 是一个去中心化的社交网络协议。
• Habla：一个支持长格式的 Nostr 客户端，适合用于撰写和发布博客文章。
• Yakihonne：另一个支持长格式的 Nostr 客户端，提供丰富的编辑功能。
• Highlighter.com：一个在线工具，支持将文章高亮显示并分享到 Nostr 网络。

通过 Oracolo，用户可以轻松创建和管理基于 Nostr 的博客，享受去中心化网络带来的自由和灵活性。

oracolo A minimalist Nostr blog that consists of a single html file 项目地址: https://gitcode.com/gh_mirrors/or/oracolo