Skip to content

fix: nested lists, and a github flavour for admonitions - #133

Merged
auscaster merged 4 commits into
mainfrom
fix/lists-and-github-alerts
Sep 1, 2026
Merged

fix: nested lists, and a github flavour for admonitions#133
auscaster merged 4 commits into
mainfrom
fix/lists-and-github-alerts

Conversation

@auscaster

@auscaster auscaster commented Sep 1, 2026

Copy link
Copy Markdown
Member

Closes the two remaining reports from @gkodinov.

Nested lists (fixes #115)

Both halves of his report, and the ordered-list case he did not mention:

  • Every list item was followed by a blank line, because a paragraph inside a list item closed as its own block.
  • Nested lists were flattened, so a two-level list rendered as seven bullets at one level.

Indentation is measured against the parent item's marker rather than a fixed width, so a list nested under 1. indents three spaces and one under * indents two. That is what Markdown needs to actually nest, and hardcoding two spaces would have quietly broken ordered lists.

The three list kinds had three identical case bodies; they are one now.

GitHub alerts (fixes #126)

--flavour github renders admonitions as GitHub alerts:

> [!NOTE]
> Flushing is best effort.

> [!WARNING]
> Blocks until the queue is empty.

@note and @remark map to [!NOTE], @warning to [!WARNING], @attention to [!IMPORTANT]. Default stays pandoc and its output is byte-identical: the two dialects now share one renderer, so the pandoc path could not drift while adding the other.

Worth knowing: no fixture had a single admonition, so the :::note path had never been rendered by a test. It has coverage in both dialects now.

Also note @deprecated reaches us as an xrefsect rather than a simplesect, so it still renders as a plain > Deprecated: … blockquote in both flavours. Mapping that would mean matching on a localised title string, which I would rather not build.

No version bump. Nothing releases until you say so.

@auscaster
auscaster force-pushed the fix/lists-and-github-alerts branch from 0dcc582 to bc8418f Compare September 1, 2026 03:11
@auscaster
auscaster merged commit dd2c12d into main Sep 1, 2026
3 checks passed
@auscaster
auscaster deleted the fix/lists-and-github-alerts branch September 1, 2026 03:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Map doxygen tags to github syntax Nested list handling in moxygen is off

1 participant