diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 5c1ec5b..b14a082 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -46,5 +46,5 @@ jobs: uses: EndBug/add-and-commit@v7 with: add: CHANGELOG.md - message: "chore: Update CHANGELOG.md" + message: "chore: Update CHANGELOG.md [skip ci]" branch: main diff --git a/README.md b/README.md index f2185c2..a70c08d 100644 --- a/README.md +++ b/README.md @@ -181,7 +181,7 @@ Saga does its work in multiple stages. 1. First, it finds all the files within the `input` folder 2. Then, for every registered step, it passes those files to matching readers (matching based on the extensions the reader declares it supports). Readers are responsible for turning for example Markdown or RestructuredText files, into `Item` instances. Such readers are not bundled with Saga itself, instead you'll have to install one such as [SagaParsleyMarkdownReader](https://github.com/loopwerk/SagaParsleyMarkdownReader), [SagaPythonMarkdownReader](https://github.com/loopwerk/SagaPythonMarkdownReader), or [SagaInkMarkdownReader](https://github.com/loopwerk/SagaInkMarkdownReader). -3. Finally Saga runs all the registered steps again, now executing the writers. These writers expect to be given a function that can turn a `RenderingContext` (which hold the `Item` among other things) into a `String`, which it'll then write to disk, to the `output` folder. To turn an `Item` into a HTML `String`, you'll want to use a template language or a HTML DSL, such as [SagaSwimRenderer](https://github.com/loopwerk/SagaSwimRenderer). +3. Finally Saga runs all the registered steps again, now executing the writers. These writers expect to be given a function that can turn a `RenderingContext` (which hold the `Item` among other things) into a `String`, which it'll then write to disk, to the `output` folder. To turn an `Item` into a HTML `String`, you'll want to use a template language or a HTML DSL, such as [SagaSwimRenderer](https://github.com/loopwerk/SagaSwimRenderer) or [SagaStencilRenderer](https://github.com/loopwerk/SagaStencilRenderer). Readers are expected to support the parsing of metadata contained within a document, such as this example for Markdown files: