1. Resources
  2. Markdown

User Documentation

This folder is the usage guide for people who want to consume domino-md from application code. It is written for the typical path a new user will take:

  1. Parse Markdown
  2. Inspect the AST
  3. Render to HTML, DOM, text, or Markdown
  4. Enable extensions
  5. Tune configuration
  1. Getting Started
  2. Parsing and ASTs
  3. Rendering Output
  4. Extensions
  5. Configuration
  6. Examples

What You Can Do With domino-md

  • Turn Markdown strings into an AST
  • Render the AST into HTML
  • Render the AST into Elemental2 DOM nodes
  • Render the AST into plain text
  • Render the AST back to canonical Markdown
  • Enable GitHub-flavored extensions such as tables, task lists, strikethrough, and autolinks
  • Build custom parsing or rendering behavior when the built-in behavior is not enough

Entry Points

  • org.dominokit.markdown.parser.Parser
  • org.dominokit.markdown.renderer.html.HtmlRenderer
  • org.dominokit.markdown.renderer.elemental2.Elemental2Renderer
  • org.dominokit.markdown.renderer.text.TextContentRenderer
  • org.dominokit.markdown.renderer.markdown.MarkdownRenderer
  • org.dominokit.markdown.extensions.discovery.ExtensionDiscovery

Example Progression

The docs intentionally move from simple to advanced:

  • First parse and render a paragraph
  • Then inspect headings, links, lists, and children
  • Then enable built-in extensions
  • Then customize rendering behavior
  • Then add your own parser or renderer hooks

That progression matters because the API is designed to stay simple for basic use while still allowing advanced customization when you need it.

We are a group of passionate people who love what we do

Donate & Support Us