Skip to content

v0.9.0

Choose a tag to compare

@github-actions github-actions released this 29 May 07:20
· 24 commits to main since this release

v0.9.0

Highlights

  • Added Markdown import helpers for turning existing Markdown into normal docscriptor objects:
    • parse_markdown(...)
    • from_markdown(...)
    • Document.from_markdown(...)
  • Markdown import covers the renderer-neutral subset most useful for handoff workflows: headings, paragraphs, ordered and unordered lists, task-list markers, block quotes, fenced and indented code blocks, thematic breaks, tables, local images, links, autolinks, emphasis, inline code, and strikethrough.
  • Added Jupyter notebook import helpers:
    • parse_ipynb(...) / parse_notebook(...)
    • from_ipynb(...) / from_notebook(...)
    • Document.from_ipynb(...)
  • Notebook import converts Markdown cells through the Markdown parser, code and raw cells to CodeBlock(...), and textual outputs to optional output blocks so exploratory notebooks can be folded into larger reports.
  • Added multicolumn document flow with MultiColumn(...) and ColumnSpan(...), including automatic wide-media spanning for figures, tables, and subfigure groups when they do not fit a single column.
  • Added configurable citation and references formatting through CitationOptions and Theme(citation_format=..., reference_format=...). Numeric citations remain the default, with support for author-year-style inline labels and APA, MLA, Chicago, IEEE, numbered, and plain reference entries.
  • Expanded lightweight inline Markdown parsing in markup(...) with reference links, inline links, angle and bare autolinks, email autolinks, underscore emphasis, strikethrough, escaped punctuation, hard line breaks, and richer code-span handling.
  • Refined JournalArticleTemplate(...) into a more content-first manuscript builder with stronger default article styling and optional acknowledgement and data availability sections.
  • Expanded the usage guide, journal paper example, template preset example, and tests to demonstrate Markdown import, notebook import, multicolumn manuscript flow, configurable citations, and the updated template preset surface.

Compatibility Notes

  • Removed older convenience aliases from the public API:
    • PageBreaker
    • VSpace
    • vspace(...)
    • HorizontalRule
    • hrule(...)
    • md(...)
  • Use PageBreak, VerticalSpace, Divider, and markup(...) directly instead of the removed aliases.
  • JournalArticleTemplate(...) now treats tuple-style manuscript sections as level-1 Section(...) blocks instead of top-level Chapter(...) blocks, matching the content-first article structure.
  • This is a minor release because backward compatibility is not guaranteed.

Renderer Notes

  • DOCX, PDF, and HTML rendering now understand MultiColumn(...) and ColumnSpan(...).
  • DOCX uses continuous section columns for top-level multicolumn flows and a layout-table fallback inside nested containers.
  • Heading, reference, citation, figure, table, comment, and footnote indexing now traverses multicolumn children.
  • Configured citation labels and reference-entry formats are used consistently across DOCX, PDF, and HTML generated references.