Thinkmill / Thinkmill/keystatic

gracefully handle `footnoteReference` and `footnoteDefinition` nodes in mdx field

Open
#990 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
2.4k
Forks
159
Avg merge
21h 41m
Merged PRs (30d)
2

Description

currently, when an mdx document has a footnote, the keystatic mdx field errors with the following error message:

Field validation failed: content: Unexpected error: Error: Unhandled type footnoteReference Unhandled type footnoteDefinition

Screenshot_20240307_190715

mdx document used:

---
title: test
---

Some text.[^1]

[^1]: Footnote content.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the MDX field validation path and reproduce the failure using the footnote-containing document shown in the issue. Trace how footnoteReference and footnoteDefinition nodes are handled; done means the document validates without the unhandled-type error.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, typescript
Domain
content
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.