Skip to content

Research: Identify 18 unsupported MkDocs features for auto-formatting#76

Draft
Copilot wants to merge 4 commits intomainfrom
copilot/research-mdformat-features
Draft

Research: Identify 18 unsupported MkDocs features for auto-formatting#76
Copilot wants to merge 4 commits intomainfrom
copilot/research-mdformat-features

Conversation

Copy link

Copilot AI commented Jan 24, 2026

Comprehensive analysis of MkDocs, Material for MkDocs, and PyMdown Extensions features that lack mdformat-mkdocs support but would benefit from consistent auto-formatting.

Deliverables

Four research documents (1,076 lines):

  • RESEARCH_INDEX.md - Navigation hub
  • RESEARCH_SUMMARY.md - Top 5 priorities, phase-based roadmap
  • RESEARCH_UNSUPPORTED_FEATURES.md - Detailed analysis with complexity assessments
  • RESEARCH_EXAMPLES.md - Syntax demonstrations for testing

Key Findings

18 features analyzed across 3 priority tiers:

High Priority (7 features):

  • PyMdown Keys (++ctrl+alt+del++) - keyboard shortcuts
  • Critic Markup ({--deleted--}{++added++}) - change tracking
  • Material Annotations - inline tooltips (v8.0+)
  • Task Lists Enhanced - checkbox normalization
  • SmartSymbols - typography preservation ((c)©)
  • MagicLink - auto-linking (@username, #123)
  • Material Grids - card layouts

Medium Priority (5 features): Highlight, Caret/Tilde, Details, Emoji, InlineHilite

Low Priority (6 features): Blocks, ProgressBar, Superfences, Tabbed, Mermaid, Data Tables

Implementation Phases

  1. Phase 1 (low complexity): Task Lists, SmartSymbols, Highlight/Caret/Tilde
  2. Phase 2 (high value): Keys, Critic Markup, InlineHilite
  3. Phase 3 (complex): Annotations, MagicLink, Emoji
  4. Phase 4 (optional): Grids, Mermaid formatting, ProgressBar

Each feature documented with: syntax examples, formatting opportunities, implementation complexity, testing strategies.

Example: PyMdown Keys

# Current (unsupported)
Press ++CTRL+alt+DEL++ or ++cmd+shift+P++

# With formatting support
Press ++ctrl+alt+delete++ or ++cmd+shift+p++

Ready for community feedback and prioritization.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • facelessuser.github.io
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)
  • squidfunk.github.io
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

Research unsupported mdformat-mkdocs features, which would benefit from auto-formatting


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 3 commits January 24, 2026 23:33
Documents 18 features from MkDocs, Material for MkDocs, and PyMdown Extensions that would benefit from auto-formatting. Includes priority rankings, complexity assessments, and implementation recommendations.

Co-authored-by: KyleKing <3784339+KyleKing@users.noreply.github.com>
Co-authored-by: KyleKing <3784339+KyleKing@users.noreply.github.com>
Complete research deliverable with 4 documents:
- RESEARCH_INDEX.md: Navigation and overview
- RESEARCH_SUMMARY.md: Quick reference (101 lines)
- RESEARCH_UNSUPPORTED_FEATURES.md: Detailed analysis (608 lines)
- RESEARCH_EXAMPLES.md: Practical examples (275 lines)

Total: 18 features analyzed across High/Medium/Low priority

Co-authored-by: KyleKing <3784339+KyleKing@users.noreply.github.com>
Copilot AI changed the title [WIP] Research unsupported mdformat-mkdocs features for auto-formatting Research: Identify 18 unsupported MkDocs features for auto-formatting Jan 24, 2026
Copilot AI requested a review from KyleKing January 24, 2026 23:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants