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

Link to pod files on GitHub #25

Open
Grinnz opened this issue Oct 29, 2019 · 7 comments
Open

Link to pod files on GitHub #25

Grinnz opened this issue Oct 29, 2019 · 7 comments
Labels
enhancement New feature or request

Comments

@Grinnz
Copy link
Owner

Grinnz commented Oct 29, 2019

As suggested at http://blogs.perl.org/users/grinnz/2019/10/request-for-feedback-perl-documentation-site.html#comment-1807822

Since Perl source is now on GitHub, we could link to the GitHub page for that source file to make documentation contributions easy.

@Grinnz Grinnz added the enhancement New feature or request label Oct 29, 2019
@Grinnz
Copy link
Owner Author

Grinnz commented Nov 11, 2019

This could also include module sources but we should take care not to do it for CPAN-upstream sources.

@scottchiefbaker
Copy link

I think this would be a great idea. 👍 from me

@MasterInQuestion
Copy link

    Somewhat related:
    Accepting a URL input for text file and render its Pod?
    E.g. https://perldoc.pl/?url=https://github.com/bugzilla/bugzilla/raw/5.2/Bugzilla/Extension.pm

@Grinnz
Copy link
Owner Author

Grinnz commented Jan 3, 2024

I don't see how that is related, and no, I will not be rendering data from arbitrary URLs.

@MasterInQuestion
Copy link

    Rationale:
    Pod relies post-rendering to properly display:
    While there lacks proper built-in support for so.
    (such is also the case for many GitHub Perl files)

    Security aspect, should be no worse than GitHub itself:
    Which just has to render these files in different manner.

@Grinnz
Copy link
Owner Author

Grinnz commented Jan 6, 2024

There are methods to render POD from arbitrary URLs to HTML, such as the perldoc command-line program. That is out of scope for this application.

@MasterInQuestion
Copy link

MasterInQuestion commented Jan 6, 2024

    Styling is a significant part, though.

    Web accessibility also.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants