Oracolo 博客搭建教程

Oracolo 博客搭建教程

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

项目概述

Oracolo 是一个基于 Nostr 构建的极简主义博客系统，它独特之处在于整个博客仅由一个 HTML 文件组成，体积轻巧，约140KB。用户可以利用支持长格式消息的任何Nostr客户端（如 habla、news、yakihonne 等）来撰写文章，并且个人博客会自动更新。该项目甚至无需Web服务器，非常适合快速分享，比如通过电子邮件作为名片发送。

1. 目录结构及介绍

Oracolo 的目录布局简洁明了，下面是主要的目录和文件说明：

• index.html: 主入口文件，也是博客的核心展示页面，包含了博客的基本结构和作者元数据。
• dist: 这是构建后的输出目录，包含编译好的静态资源，准备部署到生产环境。
• src: 源代码目录，包括博客的主要逻辑和界面元素。
  • index.svelte: Svelte组件，处理博客的动态显示部分。
  • svelte.config.js: Svelte配置文件，用于调整Svelte编译器的行为。
  • tsconfig.json: TypeScript配置文件，若项目中包含TypeScript代码则使用。
  • vite.config.ts: Vite配置文件，控制构建流程。
• docs: 可能包含额外的文档或指导信息，但在本示例中未详细说明其具体用途。
• example: 示例博客的演示文件或预览，帮助理解生成的博客样式。
• gitignore: Git忽略文件，指定了不应被版本控制系统跟踪的文件类型或文件夹。
• LICENSE.md: 许可证文件，声明本项目遵循MIT许可证。
• package-lock.json 和 package.json: NPM包管理相关文件，定义依赖项和脚本命令。

2. 项目的启动文件介绍

主要启动文件是index.html。虽然此文件在开发阶段是入口点，但在实际部署时，您将关注dist/index.html文件，这是编译和优化后，准备上线的版本。对于开发者来说，重点在于个性化这个HTML文件中的作者元标签（特别是npub），以及通过npm进行本地开发环境的设置和构建过程。

开发模式下启动流程：

1. 个性化：首先编辑index.html中的作者元标签。
2. 安装依赖：运行npm install以获取所有必需的依赖库。
3. 构建：执行npm run build，生成可在浏览器中运行的静态资源至dist目录。

3. 项目的配置文件介绍

Oracolo的配置并非集中在一个单独的传统配置文件中，而是分散在HTML头部的元标签里。这意味着您可以直接在index.html中进行配置。主要的配置项包括但不限于：

• npub元标签：个性化博客的关键，指定您的Nostr公钥。
• 可选配置：通过其他的meta标签实现，例如relays自定义中继列表，top-notes控制顶部显示笔记的数量，short-notes和相关设置来定制短笔记的展示方式，topics启用话题过滤等。

此外，如果需要更复杂的配置或定制逻辑，可以通过修改src目录下的Svelte组件和配置文件间接实现。

总结，Oracolo通过一种非常轻量级的方式提供了博客构建解决方案，将复杂性降到最低，使得内容创作者能够专注于创作本身，而无须深入了解复杂的前端技术栈。

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