If there was a mechanism to,

• Opt-into Markdown documentation on a per-file basis.
• Document your code with Markdown instead instead of POD

Assuming these concerns were met,

• A call to perldoc MyModule rendered the Markdown to text with something like mdcat which supports images, links
• No browser was required at all (mdcat works without a browser).
• Support for terminal-rendering of Markdown was a part of core.
• All of this was done merely by creating a distinction between a code-comment, and a doc-comment as demonstrated in this repo, where
  
  • A doc comment was marked with a line starting ##
  • Any other use of # continues to carry code-commenting semantics

  
  

Would you prefer it and use it?

View Poll

submitted by /u/EvanCarroll
[link] [comments]