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

Add # links for headings in generated Roc documentation #6693

Open
lukewilliamboswell opened this issue Apr 29, 2024 · 1 comment
Open

Add # links for headings in generated Roc documentation #6693

lukewilliamboswell opened this issue Apr 29, 2024 · 1 comment
Labels
docs generation Documentation genereation good first issue Good for newcomers

Comments

@lukewilliamboswell
Copy link
Collaborator

This issue proposes that we add support for markdown # links. In a URL, a hash # points a browser to a specific spot in a page or website.

The headings generated from doc comments in https://www.roc-lang.org/builtins/Str are not able to be linked to as they are just simple <h2> tags.

For example the following doc comments would generate a link for the Syntax heading.

## ## [Syntax](#syntax) {#stynax}
##
## The most common way to represent strings is using quotation marks:
##
## ```
## "Hello, World!"
## ```
@lukewilliamboswell lukewilliamboswell added docs generation Documentation genereation good first issue Good for newcomers labels Apr 29, 2024
@kencruz
Copy link

kencruz commented Jun 4, 2024

Hi, I'd like to work on this one please

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs generation Documentation genereation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants