Skip to content

1.10.0 - Support multiple centered README description paragraphs

Choose a tag to compare

@allanmcarvalho allanmcarvalho released this 04 Nov 18:02
· 14 commits to 1.x since this release

Added

  • Multi-paragraph centered README descriptions: The README head rendering now supports multiple centered description paragraphs instead of a single description string.
  • Multi-line description API: The README head model introduces a multi-line description accessor (descriptionLines()), allowing callers to provide description content as lines/paragraphs.
  • Paragraph-by-paragraph rendering: The README head writer renders each paragraph as its own centered <p> block.
    • Inline Markdown is converted per line/paragraph.
    • HTML is escaped for safety while link handling remains appropriate for Markdown rendering.
    • Whitespace is normalized during rendering.
    • Only the first paragraph includes id="maintainer-description"; subsequent paragraphs are rendered without that ID.

Changed

  • Breaking/compatibility considerations for description handling:
    • The rendering behavior changes from the previous single-description approach.
    • Callers relying on the old withDescription(?string) semantics (or expecting a single description string) should update to the new multi-line model.
    • If you previously provided one string and relied on "\n\n" paragraph joining behavior externally, you may now need to supply description content via the new line/paragraph API (for example via string arrays or incremental APIs like appendDescriptionLine()).
  • Output formatting differences:
    • The writer no longer uses the previous single-description HTML escaping path.
    • Exact HTML/Markdown rendering may differ from earlier versions, especially around inline formatting and paragraph boundaries.