modules.raku.org icon indicating copy to clipboard operation
modules.raku.org copied to clipboard

AsciiDoc README files are not rendered

Open araraloren opened this issue 7 years ago • 10 comments

The README of my module is written in asciidoc, I am not using markdown. Can you add this format support ?

The module url: http://modules.perl6.org/dist/Terminal::Table:cpan:ALOREN

araraloren avatar Jan 30 '18 14:01 araraloren

I'm not quite sure I understand the problem. Can you please ellaborate?

JJ avatar Feb 17 '18 19:02 JJ

@JJ most README files are using Markdown. This ticket is asking for AsciiDoc support.

AlexDaniel avatar Feb 17 '18 19:02 AlexDaniel

Here's an example of a rendered README.md file: https://modules.perl6.org/dist/JSON::Fast:cpan:TIMOTIMO.

AlexDaniel avatar Feb 17 '18 19:02 AlexDaniel

OK, I get it now. It only supports Markdown, right? Not even pod6.

JJ avatar Feb 17 '18 19:02 JJ

Or even pod https://modules.perl6.org/dist/zef:cpan:UGEXE

JJ avatar Feb 17 '18 19:02 JJ

Yes.

AlexDaniel avatar Feb 17 '18 19:02 AlexDaniel

FWIW, the code for the renderer is here: https://github.com/perl6/modules.perl6.org/blob/484ca3d1c3ae1fb7fdce7e18d1d6edeef7bf0180/lib/ModulesPerl6/Controller/Dist.pm#L118-L131

zoffixznet avatar Feb 17 '18 19:02 zoffixznet

Thanks. I've tried to look it up and actually couldn't find anything.

JJ avatar Feb 17 '18 19:02 JJ

That code looks pretty specific, it would need a major refactor. And if it comes to that, I'd opt for using pandoc or something like that to take all formats to a common DOM.

JJ avatar Feb 17 '18 19:02 JJ

Looks like there's even a module for it already and we have pandoc 1.17.2 on the server (I installed that module just now as well)

zoffixznet avatar Feb 17 '18 19:02 zoffixznet