dtonon / oracolo

A minimalist Nostr blog that consists of a single html file
MIT License
144 stars 8 forks source link
nostr nostr-client

Oracolo

Oracolo is a minimalist blog powered by Nostr, that consists of a single html file, weighing only ~140Kb. You can use whatever Nostr client that supports long format (habla.news, yakihonne, highlighter.com, etc) to write your posts, and your personal blog is automatically updated.
It works also without a web server; for example you can send it via email as a business card.

Oracolo preview

Examples

Here you can find some generated blogs for OpenSats, Hodlbod and fiatjaf.

How to use - Developer mode

1) Open index.html and personalize the author meta tag with your npub 2) Run npm install 3) Run npm run build 4) Deploy the generated dist/index.html file

How to use - "I hate npm" mode

1) Open directly dist/index.html and personalize the author meta tag with your npub 2) Save the file and deploy

Optional settings

In addition to the npub meta in the index.html there are other optional meta tags to configure:

relays: set a list of custom relays;
top-notes: show N notes in a boxed format with cover image, zero to disable;
short-chars: show short notes (kind:1) with more than X characters in a carousel, zero to disable;
topics: let user navigate by topics, filtering articles by tags, empty to disable;
comments: enable comments at the bottom of the articles, with NIP-7 + NIP-46 login;

https://github.com/dtonon/oracolo/assets/89577423/f71b8bc5-ecca-4a28-98fb-f3afe1d6698e

Why this ugly hash routing?

Because this way the blog has fully functioning permalinks, without needing any additional server-level configuration to capture all the urls.

Caveats / To do

SEO is currently not existent, work in progress.
No pagination in the home.