https://github.com/dtonon/oracolo

A minimalist Nostr blog that consists of a single html file
https://github.com/dtonon/oracolo

Last synced: 17 days ago
JSON representation

A minimalist Nostr blog that consists of a single html file

• Host: GitHub
• URL: https://github.com/dtonon/oracolo
• Owner: dtonon
• Created: 2024-05-20T10:59:47.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-05-22T12:03:50.000Z (6 months ago)
• Last Synced: 2024-05-22T12:33:16.370Z (6 months ago)
• Language: HTML
• Size: 352 KB
• Stars: 102
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-nostr - Oracolo - Oracolo is a minimalist blog, powered by Nostr, that consists of a single html file. (Clients / Relay lists)

README

        
# Oracolo

Oracolo is a minimalist blog powered by [Nostr](https://njump.me), that consists of a single html file, weighing only ~140Kb.

You can use whatever Nostr client that supports long format ([habla.news](https://habla.news), [yakihonne](https://yakihonne.com), [highlighter.com](https://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](docs/oracolo.jpg)

## Examples

Here you can find some generated blogs for [OpenSats](https://raw.githack.com/dtonon/oracolo/master/examples/opensats.html), [Hodlbod](https://raw.githack.com/dtonon/oracolo/master/examples/hodlbod.html) and [fiatjaf](https://raw.githack.com/dtonon/oracolo/master/examples/fiatjaf.html).

## 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-notes`: show short notes as carousel (value 'carousel') or in the main feed (value 'main'), empty to disable;  

`short-notes-min-chars`: show short notes with X minimum characters for the 'short-notes' setting, zero to disable;  

`short-notes-summary-max-chars`: size in characters of the short notes preview in the feed, zero to display full content;  

`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.