metacpan-web icon indicating copy to clipboard operation
metacpan-web copied to clipboard

Rendering of markdown files

Open gugod opened this issue 5 years ago • 3 comments

It would be nice to see that markdown files in distributions can be identified as "documentation" and linked to their rendered version instead of only be linked to their source form the "Browse" UI.

Only a tiny percentage of distributions contains a few markdown files. But they are there. Here are some examples:

  • https://metacpan.org/source/SJDY/Mojo-Webqq-2.2.7/API.md
  • https://metacpan.org/source/ROCKY/B-DeparseTree-v3.4.0/doc/precedences.md
  • https://metacpan.org/source/ROMM/Net-SharePoint-Basic-0.11/CONTRIBUTING.md
  • https://metacpan.org/source/DACAV/PFT-v1.3.0/README.md

There are a lot of README.md, but there are something else as well.

I'd like to work on a draft of this and ask for reviews.

gugod avatar Jul 20 '19 01:07 gugod

If you would like to put something together, that would be great! Related to #2191

oalders avatar Jul 20 '19 01:07 oalders

Vote::Count is a documentation heavy distribution, and I would prefer to be writing Markdown to pod. I have script generating pod from markdown, I would love to see Metacpan support GFM equally with POD. So if I have somemodule.pm and somemodule.md in the directory name it would be treated the same as if it were somemodule.pod.

brainbuz avatar Sep 02 '19 19:09 brainbuz

Just a note: we've taken a small step forward towards this and are now rendering Markdown as HTML instead of raw source. For example, https://metacpan.org/source/JLCOOPER/DBD-Mock-1.50/README.md

PatrickCronin avatar Oct 25 '19 01:10 PatrickCronin