jessebrault/ssg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Update CHANGELOG.md

Browse Source
This commit is contained in:
JesseBrault0709 2023-02-13 13:56:14 +01:00 committed by GitHub
parent c608be5d9a
commit 0b57ec827c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
CHANGELOG.md
View File

@ -2,14 +2,14 @@
All notable changes to SSG will be documented in this file. All notable changes to SSG will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## Next/Unreleased ## Next
### Added ### Added
- A `tagBuilder` of type `DynamicTagBuilder` is available in Templates, SpecialPages, and Parts. - A `tagBuilder` object of type [`DynamicTagBuilder`](lib/src/main/groovy/com/jessebrault/ssg/tagbuilder/DynamicTagBuilder.groovy) is available in Templates, SpecialPages, and Parts.
```groovy ```groovy
def simpleTag = tagBuilder.test() def simpleTag = tagBuilder.test()
assert simpleTag == '<test />' assert simpleTag == '<test />'
@ -23,11 +23,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
def tagWithAttributesAndBody = tagBuilder.p([id: 'my-paragraph'], 'Hello, World!') def tagWithAttributesAndBody = tagBuilder.p([id: 'my-paragraph'], 'Hello, World!')
assert tagWithAttributesAndBody == '<p id="my-paragraph">Hello, World!</p>' assert tagWithAttributesAndBody == '<p id="my-paragraph">Hello, World!</p>'
``` ```
This is likely most useful for building simple, one-line html/xml tags.
[93687d](https://github.com/JesseBrault0709/ssg/commit/936587d).
- **Breaking**: the `text` object in Templates is now an instance of `EmbeddableText` instead of `String`. Thus, one must
use `text.render()` to obtain the rendered text. [34d9cd5](https://github.com/JesseBrault0709/ssg/commit/34d9cd5).
- Parts have a `text` object of type `EmbeddableText`. If we are rendering a part called from anything other than a Template
(which has an associated text), this will be `null`. [34d9cd5](https://github.com/JesseBrault0709/ssg/commit/34d9cd5).
### Fixed This is likely most useful for building simple, one-line html/xml tags. [93687d](https://github.com/JesseBrault0709/ssg/commit/936587d).
- Parts have a `text` object of type [`EmbeddableText`](lib/src/main/groovy/com/jessebrault/ssg/text/EmbeddableText.groovy). If one is rendering a Part called from anything other than a Template (which has an associated text), this will be `null`. [34d9cd5](https://github.com/JesseBrault0709/ssg/commit/34d9cd5).
### Changed
- **Breaking**: the `text` object in Templates is now an instance of [`EmbeddableText`](lib/src/main/groovy/com/jessebrault/ssg/text/EmbeddableText.groovy) instead of `String`. Thus, one must use `text.render()` to obtain the rendered text. [34d9cd5](https://github.com/JesseBrault0709/ssg/commit/34d9cd5).
### Deprecated
- The `frontMatter` object in Templates is now deprecated. Use `text.frontMatter` instead.