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

Perl 6 Pod Rendering #907

Closed
zoffixznet opened this issue Jun 30, 2016 · 6 comments
Closed

Perl 6 Pod Rendering #907

zoffixznet opened this issue Jun 30, 2016 · 6 comments

Comments

@zoffixznet
Copy link

Hi,

We'd like to have Perl 6 Pod documents rendered on GitHub, just as Perl 5 Pod documents get rendered.

We can do the legwork and add the PR to this repo, but my question is what would be involved in having the P6Pod to HTML converter installed. It'll basically involve installing a perl 6 compiler and Pod::To::HTML module. We also have a Docker image if that's a better solution.

Let us know how we can proceed with having GitHub display Perl 6 Pod.

Thanks.

@zoffixznet
Copy link
Author

Hi, any suggestions?

@gjtorikian
Copy link
Contributor

Hi @zoffixznet ! Sorry for the late reply.

In terms of installing the Perl6 software and modules, we'll handle that on our end. It may take us some time to do this, as any new packages introduced are vetted by our security and ops teams.

You're certainly more than welcome to perform a PR with tests, and update the .travis.yml file so that our CI test suite verifies that Perl6 documentation is being generated.

cc @github/workflow

@tbrowder
Copy link

When you say "PR with tests" to what repo do you refer? (Or do you mean test any repo using a pod6 document?)

@gjtorikian
Copy link
Contributor

Ah! To clarify: you should add the Ruby glue necessary for this gem to properly render Perl6 POD files.

By tests, I mean that you should also add a markup file and an expected HTML rendered file to ensure that the input produces consistent output. We have a folder full of these sorts of tests: https://github.com/github/markup/tree/master/test/markups

Does that clarify it?

JJ added a commit to JJ/markup that referenced this issue Mar 12, 2018
JJ added a commit to JJ/markup that referenced this issue Mar 12, 2018
Closes github#907 when accepted (along with the rest of the commits).
@kivikakk
Copy link
Contributor

kivikakk commented Sep 5, 2018

Closing this as stale (2y old); if you can get a PR together, we can keep moving on this.

@kivikakk kivikakk closed this as completed Sep 5, 2018
@tbrowder
Copy link

tbrowder commented Sep 5, 2018

Thanks. Someone will tackle this eventually.

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

4 participants