Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Loading…

Hyperlink to sections of PSR-2 #55

Closed
p opened this Issue · 8 comments

4 participants

Oleg Pudeyev David King Michael C. Paul Dragoonis
Oleg Pudeyev
p commented

I've been told it is possible to hyperlink to sections within a markdown document. If so please arrange for that to happen in both PSR-1 and PSR-2. Thanks.

A table of contents would be superb as well.

David King

For reference, I believe the syntax for hyperlinking within a markdown document is:

[Name of Link][]

If that doesn't work like I think it does (although, otherwise I'm not sure how it's done in the following links), straight HTML should be a feasible soltuion.

See:

Michael C.

I don't think a table of contents would be practical in the long run. https://github.com/php-fig/fig-standards/tree/master/accepted essentially runs as a contents.

David King

@unknownbliss he means within the document. If you are wanting to point someone to a specific coding standard within the document, you currently have to say "Go to the PSR-#, scroll down about midway to X Section, and find point Y". With a TOC, you could link directly to the section.

Michael C.

Github readme.md's automatically add links, its a shame they dont to it to all markdown files seeing as it parses them.

Paul Dragoonis
Owner

@p are you planning on adding hyperlinks into markdown documents for PSR 1/2 ?

Oleg Pudeyev
p commented

They are mystery meat navigation in github but they are there, if you know where to look.

Paul Dragoonis
Owner

I'm closing this since it's just a suggestion to make things hyperlinks but no PR has been issued since it was opened 3 months ago. If someone is interested in doing this please make a PR. Thanks.

Paul Dragoonis dragoonis closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.