Back to Explore

syntax-tree/mdast-util-gfm-footnote

GitHub
2 watchersOpen source

Last release:

mdast-util-gfm-footnote is an mdast extension that parses and serializes GitHub Flavored Markdown (GFM) footnotes into mdast syntax tree nodes, integrating with mdast-util-from-markdown and mdast-util-to-markdown. It is useful when you already use mdast utilities and want to handle GFM footnote syntax in markdown.

Project status

  • The source appears actively maintained, with an upstream push on 2026-06-03, though the last published package update in the provided history is 2.1.0 (2025-02-10).
  • Update cadence looks uneven: major work was released in 2021, then 2023, then 2025, and there is evidence of continued upstream activity in 2026 without a corresponding published update shown here.

AI summary generated

AI-generated from public sources. May be inaccurate. Report

Recent updates

  • 2.1.0

    Release 2.1.0 adds a new `firstLineBlank` option to control whether serialized footnote definitions start with a blank line. The release also includes TypeScript declaration refactors (switching to `@import`s) and enables `declarationMap` generation. Code changes include updates to the serializer implementation and corresponding type/documentation/tests.

    Features
  • 2.0.0

    Release 2.0.0 upgrades the package to require Node.js 16 and updates internal integration points with mdast-util-to-markdown. It also updates @types/mdast and the mdast utilities it depends on.

    Breaking
  • 1.0.2

    Release 1.0.2 is described as documentation improvements, code-style refactors, and a tsconfig update. However, the diff shows a larger structural change: the implementation was moved into a new lib/ directory, TypeScript typings were added/reshaped via index.d.ts, and some module-level initialization behavior changed.

    BreakingFeatures
  • 1.0.1

    Version 1.0.1 removes console warnings emitted during GFM footnote serialization, specifically for footnote identifiers containing colons and for list nodes inside footnote definitions. It also introduces location tracking via mdast-util-to-markdown's `track` utility, updating how output text is assembled. The release notes only mention warnings removal and location tracking at a high level.

    Features
  • 1.0.0

    Release 1.0.0 was published on 2021-10-03. The release notes do not describe any changes or features beyond linking to the full changelog commits for version 1.0.0.