Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GitHub Pod Parsing/Rendering #35

Open
AlexDaniel opened this issue Jan 2, 2019 · 2 comments
Open

GitHub Pod Parsing/Rendering #35

AlexDaniel opened this issue Jan 2, 2019 · 2 comments

Comments

@AlexDaniel
Copy link
Member

Currently GitHub renders .pod6 files as text. It would be great if they were parsed and rendered properly as POD6 files (with proper HTML output).

Example: https://github.com/perl6/doc/blob/master/doc/Type/IO/Socket/INET.pod6

There was an attempt to implement that, but in the end it was rejected because perfect POD6 parsers need to execute the file in order to render it correctly. So it seems that we need a solution that doesn't run any code, and instead attempts to render POD6 according to some basic (existing) rules.

See previous ticket: Raku/doc#167

@AlexDaniel
Copy link
Member Author

I wonder if we can use https://github.com/perl6/atom-language-perl6/ (or any other basic perl6 parser) to output some pages. It doesn't have to be absolutely correct, just rendering some headings and paragraphs will do.

@raiph
Copy link

raiph commented Jan 3, 2019

See also Raku/Pod-To-HTML#55 (comment) (and the comment immediately preceding it which documents the original discussion of this issue in 2009). In my comment I propose a solution that I think is simple and requires no action on GH's part. It may be a non-starter for reasons I don't see -- it is a strawman proposal -- but if so, please say why.

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

No branches or pull requests

2 participants