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

Clickable linkable headers in rails guides #27958

Closed
mbigras opened this issue Feb 10, 2017 · 3 comments
Closed

Clickable linkable headers in rails guides #27958

mbigras opened this issue Feb 10, 2017 · 3 comments

Comments

@mbigras
Copy link

mbigras commented Feb 10, 2017

Hello Rails team!

One of the features I love about viewing markdown on GitHub is I'm able to easily link to headers.

On rubyonrails.org you're able to link to headers also. For example, this a link a section about dealing with basic forms.

However, it's only possible to link to these sections by scrolling up to the right bar and clicking on the relevant section; you can't just click on the header link when viewing a markdown file on GitHub.

Reading through the documentation contribution section and it looks markdown is used for the guides.

  • Does the clickable functionality come from the type of renderer used?
  • What does rubyonrails.org use to render markdown?
  • What should I start learning/reading/doing if I'd like to eventually have clickable headers for the rails guides?

I looked through the documentation contributing guidelines but nothing jumped out at me immediately.

@maclover7
Copy link
Contributor

cc @fxn

@cefigueiredo
Copy link
Contributor

Rails guides uses Redcarpet Markdown

@mbigras
Copy link
Author

mbigras commented Feb 22, 2017

@cefigueiredo thank you for the jumpstart!

Will look through vmg/redcarpet and see if I can find anything helpful 👍

@mbigras mbigras closed this as completed Mar 29, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants