diff options
| author | la-ninpre <aaoth@aaoth.xyz> | 2025-12-10 22:48:14 +0300 |
|---|---|---|
| committer | la-ninpre <aaoth@aaoth.xyz> | 2025-12-10 22:48:14 +0300 |
| commit | f3fcd25e29d1a8c4d355eb650091e2920def658e (patch) | |
| tree | 7f537b44a47359e5437e67251b3a5d4de1bb642c /README.md | |
| download | html-journal-f3fcd25e29d1a8c4d355eb650091e2920def658e.tar.gz html-journal-f3fcd25e29d1a8c4d355eb650091e2920def658e.zip | |
init
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..9d29a4e --- /dev/null +++ b/README.md @@ -0,0 +1,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. |