upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--23.md34
1 files changed, 15 insertions, 19 deletions
diff --git a/23.md b/23.md
index d1353af..5400966 100644
--- a/23.md
+++ b/23.md
@@ -12,11 +12,18 @@ This NIP defines `kind:30023` (a parameterized replaceable event according to NI
12 12
13### Format 13### Format
14 14
15The `.content` of these events should be a string text in Markdown syntax, including YAML front-matter for other metadata that may be necessary. 15The `.content` of these events should be a string text in Markdown syntax.
16 16
17### Metadata 17### Metadata
18 18
19This 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. 19For the date of the last update the `.created_at` field should be used, for "tags"/"hashtags" (i.e. topics about which the event might be of relevance) the `"t"` event tag should be used, as per NIP-12.
20
21Other metadata fields can be added as tags to the event as necessary. Here we standardize 4 that may be useful, although they remain strictly optional:
22
23- `"title"`, for the article title
24- `"image"`, for an image to be shown along with the title
25- `"summary"`, for the article summary
26- `"published_at"`, for the timestamp in unix seconds (stringified) of the first time the article was published
20 27
21### Editability 28### Editability
22 29
@@ -36,29 +43,18 @@ The idea here is that having these tags is that reader clients can display a lis
36 43
37The same principles can be applied to `nevent1...`, `note1...`, `nprofile1...` or `npub1...`. 44The same principles can be applied to `nevent1...`, `note1...`, `nprofile1...` or `npub1...`.
38 45
39## Example of an event 46## Example Event
40
41Article text:
42
43```markdown
44title: Lorem Ipsum
45---
46
47Lorem [ipsum][3] 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.
48
49Read more at #[2].
50```
51
52Derived event:
53 47
54```json 48```json
55{ 49{
56 "kind": 30023, 50 "kind": 30023,
57 "created_at": 1000000000, 51 "created_at": 1675642635,
58 "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].", 52 "title": "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.\n\nRead more at #[3].",
59 "tags": [ 53 "tags": [
60 ["d", "lorem-ipsum"], 54 ["d", "lorem-ipsum"],
61 ["t", "plceholder"], 55 ["title", "Lorem Ipsum"],
56 ["published_at", "1296962229"],
57 ["t", "placeholder"],
62 ["e", "b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87", "wss://relay.example.com"], 58 ["e", "b3e392b11f5d4f28321cedd09303a748acfd0487aea5a7450b3481c60b6e4f87", "wss://relay.example.com"],
63 ["i", "30023:a695f6b60119d9521934a691347d9f78e8770b56da16bb255ee286ddf9fda919:ipsum", "wss://relay.nostr.org"] 59 ["i", "30023:a695f6b60119d9521934a691347d9f78e8770b56da16bb255ee286ddf9fda919:ipsum", "wss://relay.nostr.org"]
64 ], 60 ],