Commit Graph

11 Commits

Author SHA1 Message Date
Marty Oehme 5526b3d2c5
docs: Update limitation information 2024-05-07 10:54:11 +02:00
Marty Oehme 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
Marty Oehme 3bd6247888
chore: Add license and dev instructions 2024-01-23 10:15:51 +01:00
Marty Oehme f67ac8cdb3
chore: Fix markdown lint issues 2023-10-12 19:26:41 +02:00
Marty Oehme 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
Marty Oehme 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
Marty Oehme 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
Marty Oehme 9674592a9f
docs: Add developer notes to README 2023-09-20 09:14:43 +02:00
Marty Oehme b564ab4792
Add continuous integration pipeline
ci/woodpecker/push/test unknown status Details
ci/woodpecker/push/lint Pipeline was successful Details
ci/woodpecker/push/static_analysis Pipeline was successful Details
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
Marty Oehme fab58a9fc5
Add preliminary README 2023-08-28 16:42:16 +02:00
Marty Oehme a22cc635b2
initial commit 2023-08-28 10:28:06 +02:00