aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 9d29a4e0b893f4f1e8190e097d3ae8eec5b90ced (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
# html-journal

this is a library for parsing [html-journal](https://journal.miso.town) format.
it also includes a little tool to generate feed from a journal.

originally made by m15o. this repo includes a more strict version of the format.

for example, original implementation could parse this:

```
<h1>test</h1>
<p>some text</p>
<div>
	<section>
		<h2>2025-12-10</h2>
		<p>an entry</p>
	</section>
</div>
```

but this library will not. it expects a h1 heading,
then some article tags at the same level that contain h2 heading,
which starts with a `YYYY-MM-DD` date.

## installation

```
$ go install git.sr.ht/~la_ninpre/html-journal@latest
```

## usage

```
$ html-journal file.html 'url' > atom.xml
```

## licence

ISC. see `LICENCE` file in the repo.