Commit graph

13 commits

Author SHA1 Message Date
424ad34c68
refactor: Rename cli options for extractor and template
Renamed the extractor selection from the cli to '--input' since it
decides the various input formats that are used to gather annotations
from.
Renamed the template selection from the cli to '--output' since it
control the output format that annotations are displayed/written in.

This also somewhat more closely mirrors pandoc cli options, which are
generally a good guide to follow.
2024-11-30 12:14:55 +01:00
103c2ea2fc
chore: Switch to uv packaging and hatch backend
Switching this project over to the uv package manager as a pilot project
for my personal use.
Since this project is not yet widely used I can use it as an
experimental playground for discovering uv further without interrupting
anybody's workflow.
2024-11-15 11:28:50 +01:00
5526b3d2c5
docs: Update limitation information 2024-05-07 10:54:11 +02:00
2f41906e6a
docs: Add extractor and install info
Added extractor info for the two currently existing extractors.
Added install recommendation for pipx.
2024-01-24 12:21:51 +01:00
3bd6247888
chore: Add license and dev instructions 2024-01-23 10:15:51 +01:00
f67ac8cdb3
chore: Fix markdown lint issues 2023-10-12 19:26:41 +02:00
ee4690f52b
feat: Add atx-style markdown
Added markdown with atx style headers, can be chosen as
alternative markdown template on the cli.
The existing 'markdown' template will still default to
setext-style headers.
2023-09-21 22:05:39 +02:00
3670f70319
docs: Add formatting documentation
Added documentation on using output templates and that they will
invalidate the 'existing' annotation search.
2023-09-20 09:15:00 +02:00
5a6d672c76
refactor: Move formatting logic to formatters
Formatters (previously templates) were pure data containers before,
continating the 'template' for how things should be formatted using
mustache. The formatting would be done a) in the exporters and b) in the
annotations.

This spread of formatting has now been consolidated into the Formatter,
which fixes the overall spread of formatting code and now can coherently
format a whole output instead of just individual annotations.

A formatter contains references to all documents and contained
annotations and will format everything at once by default, but the
formatting function can be invoked with reference to a specific
annotated document to only format that.

This commit should put more separation into the concerns of exporter and
formatter and made formatting a concern purely of the formatters and
annotation objects.
2023-09-20 09:14:58 +02:00
9674592a9f
docs: Add developer notes to README 2023-09-20 09:14:43 +02:00
b564ab4792
Add continuous integration pipeline
Some checks failed
ci/woodpecker/push/test unknown status
ci/woodpecker/push/lint Pipeline was successful
ci/woodpecker/push/static_analysis Pipeline was successful
Added static analysis (lint, type checking) to be done on each push, and
testing to be done on each master branch commit.
2023-08-29 12:15:10 +02:00
fab58a9fc5
Add preliminary README 2023-08-28 16:42:16 +02:00
a22cc635b2
initial commit 2023-08-28 10:28:06 +02:00