API Reference#
- 1. The Mdformat Plugin Entry Point
- 2. Typed configuration schema for the MyST plugin
- 3. Reusable In-Process Conversion Sessions
- 4. The Typed Document Model (nodes, token bridge, and traversal)
BlockBreakBlockquoteBreakCodeCommentDefinitionDescriptionDefinitionListDefinitionTermDeleteDirectiveDocEmphasisFootnoteDefinitionFootnoteReferenceFrontMatterHeadingIgnoredEmbedHighlightImageInlineTypstRawInlineCodeInlineMathInlineUnknownLinkListListItemMathMappingGradeNodeParagraphRoleRootSpanStrongTableTableCellTableRowTargetTextThematicBreakTokenRawSyntaxRawTypstRawUnknownchildren_of()find_all()from_tokens()get()to_tokens()transform()visit()walk()walk_with_path()
- 5. Format Readers (source text -> typed Doc)
- 6. Format Writers (typed Doc -> target text)
- 7. The Degradation Engine (capability-driven lowering, annotate + report)
- 8. Collections (N documents, and the references between them)
- 9. Markdown Dialect Plugins (markdown-it rules + mdformat renderers)
- 10. The Assist Seam (opt-in, degrade-only LM suggestions)
- 11. The Configuration Layer (``myform.yaml`` + ``[tool.myform]`` + ``.py`` extensions)
- 12. Command-line interface for translating and formatting documents with ``myform``
- 13. MyST Markdown to AST Parsing
- 14. AST to MyST Markdown Rendering
- 15. Rendered Markdown Text Postprocessing
- 16. Fold-aware Markdown table rendering
- 17. Semantic Line Break (SemBr) Paragraph Reflow
- 18. Skip-formatting ("ignore") comments -- the mdformat #53 gap, filled for MyST
- 19. Declarative Inter-Block Spacing Policies
- 20. Shared safe-Setext policy for CommonMark-family readers
- 21. Markdown-It Rule Ordering Tables
- 22. Regex and Registration Utilities