NIP-23

Long-form Content

draft optional author:fiatjaf

This NIP defines kind:30023 (a parameterized replaceable event according to NIP-33) for long-form text content, generally referred to as "articles" or "blog posts".

"Social" clients that deal primarily with kind:1 notes should not be expected to implement this NIP.

Format

The .content of these events should be a string text in Markdown syntax, including YAML front-matter for other metadata that may be necessary.

Metadata

This NIP defines only title as the metadata. For the date of publication the event .created_at field should be used, and for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the "t" event tag should be used, as in NIP-12.

Editability

These articles are meant to be editable, so they should make use of the replaceability feature of NIP-33 and include a "d" tag with an identifier for the article. Clients should take care to only publish and read these events from relays that implement that. If they don't do that they should also take care to hide old versions of the same article they may receive.

Linking

The article may be linked to using the NIP-19 nref code, which should contain both the public key of the author and the article identifier (the "d" tag) and some relays. With that information it is possible to locate the article.

References

Writing clients should implement support for parsing pasted NIP-19 nref identifiers and adding them automatically to the list of .tags of the event, replacing the actual content with a string like #[tag_index] in the same way as NIP-08 -- or, if the reference is in the form of a URL (for example, [click here](nref...)) then they should be replaced with just the tag number directly (for example, [click here][0]).

Reader clients should parse the Markdown and replace these references with either internal links so the referenced events can be accessed directly, with NIP-21 nostr: links or direct links to web clients that will handle these references.

The idea here is that having these tags is that reader clients can display a list of backreferences at the bottom when one article mentions another.

`kind:1` interface

In case there is the desire for users or clients to share the written article on their "social" clients, a kind:1 event must be used.

Since "social" clients aren't expected to understand this NIP, these notes should contain a URL like nostr:nref1... specifying the nref1 code for the article, such that it can be rendered clickable and other users can use a different client than their "social" to read the article -- and also if their client handles both kinds of posts, their client may recognize the URL and handle it internally.

For clients that want to implement the ability for users to comment on these articles. kind:1 notes should be used as the comments. They must be made in reply to another kind:1 as above, such that other people on "social" clients can see the comments and get the context from the note above and load the article being commented on if they so desire.

Example of an event

Article text:

title: Lorem Ipsum
---

Lorem [ipsum][4] dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Read more at #[3].

Derived event:

{
  "kind": 30023,
  "created_at": 1000000000,
  "title": "Lorem Ipsum\\n---\\n\\nLorem [ipsum][4] dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.\n\nRead more at #[3].",
  "tags": [
    ["d", "lorem-ipsum"],
    ["t", "lorem"],
    ["t", "ipsum"],
    ["e", "b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87", "wss://relay.example.com"],
    ["e", "a695f6b60119d9521934a691347d9f78e8770b56da16bb255ee286ddf9fda919", "wss://relay.nostr.org"]
  ],
  "pubkey": "...",
  "id": "..."
}

4.5 KiB Raw Blame History