Roadmap

This document outlines the planned features, enhancements, and long-term vision for the MarkdownGuideHtmlConverter project.

✅ Completed

These features are already implemented and functional:

Headings (#, ##, ###, etc.)
Heading underlining (e.g., Heading\n=== for H1 or Heading\n--- for H2)
Basic text styles (bold, italic, ~~strikethrough~~, ==highlighted==)
Subscript and superscript (e.g., H~2~O, E=mc^2^)
Blockquotes
Inline code and horizontal rules
Hyperlinks and images (with alt/title)
Multi-level ordered lists and unordered lists
Mixed nesting of ordered and unordered lists
Task lists (with checkbox states)
Tables with column alignment
Code blocks (with language hints)
Footnotes with multi-line support and backlinking
Raw HTML passthrough (audio, video, etc.)
YAML front-matter → meta tags
Automatic Table of Contents [TOC]
🚨 Warnings for syntax and security issues (e.g., unclosed bold, italic, ==highlight==, etc.)
🛡️ Built-in XSS protection with sanitization of dangerous content
🚨 Warnings for security issues (e.g., embedded <script> tags or suspicious links)
✅ The generated HTML code is valid according to W3C standards, verified through the W3C Validator.

Headings (<h1>–<h6>)
Basic text styles (<strong>, <em>, <del>, <mark>)
Subscript and superscript (e.g., <sub>, <sup>)
Span elements with class attributes (e.g., <span class="lang-en">)
Blockquotes
Ordered lists and unordered lists
Task lists (with checkbox states)
Links
Images with alt and title attributes (e.g., <img src="..." alt="..." title="...">)
Tables
- Pipe-style tables with alignment (e.g., | --- | :---: | ---: |)
Preformatted text blocks (e.g., <pre>...</pre>)
Code blocks with language highlighting (e.g., <pre><code class="language-csharp">...</code></pre>)
Front matter (YAML metadata block)
- Supports title and custom meta tags for HTML <head>
🚨 Warnings for syntax issues (e.g., improperly closed tags, unknown HTML entities, unexpected characters inside <pre> blocks)

Converts the most widely used AmigaGuide commands (rare or advanced commands may not be fully supported):
- Nodes (@NODE, @ENDNODE, @TOC, @NEXT, @PREV)
- Global commands (@DATABASE, @VER$, @(C), @TITLE, @AUTHOR)
- Attribute commands (@{B}, @{I}, @{U}, @{PLAIN}, @{"Doc" LINK "doc.guide/intro"}, @{"Doc" SYSTEM "<command> doc.readme"})
  - For example, @{"Doc" LINK "doc.guide/intro"} creates a link to a node in another document (the LINK command specifies the target node or file), and @{"Doc" SYSTEM "<command> doc.readme"} opens documents with external commands (the SYSTEM command executes a system command, such as opening a file with an external viewer).
  - See AmigaGuide documentation for more details on these command forms.
Preserves the document’s structure for a retro feel
Generates clean HTML navigation buttons between nodes
Escapes special HTML characters to safely display content
🚨 Warnings for syntax issues (e.g., improperly closed tags, repeated tags, unknown commands, link syntax errors, etc.)
✅ The generated HTML code is valid according to W3C standards, verified through the W3C Validator.

Recognizes simple headings (e.g., Heading\n=== for H1 or Heading\n--- for H2) or uppercase headings (e.g., ` HEADING for H1 or HEADING` for H2).
Converts bulleted lists (lines starting with -, *, or +)
Adds paragraph tags and basic inline formatting
Escapes unsafe characters (<, >, &) automatically
Outputs valid, minimal, styled HTML — ideal for fast previewing or lightweight rendering of plain notes
🔐 It scans the input for potential XSS and phishing vulnerabilities (e.g., embedded <script> tags or suspicious links).

Features and improvements currently in development or planned:

Ideas under consideration or awaiting user feedback:

Have an idea, feature request, or improvement?

Feel free to open an issue or start a discussion here:
👉 GitHub Discussions

Thanks for using and supporting this project!