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 gatsby-remark-autolink-headers #124

Closed
wants to merge 1 commit into from
Closed

Add gatsby-remark-autolink-headers #124

wants to merge 1 commit into from

Conversation

tmeasday
Copy link
Member

@tmeasday tmeasday commented Jul 31, 2020

Solves chromaui/learnstorybook.com#347 very nicely indeed!

@jonniebigodes -- note that the links (in the source markdown) need to have a trailing .md (before the #) like I POC-ed in this branch

Note the link changed there in storybookjs/storybook@dcff96b is the "custom webpack configuration" link. Note that it works both:

  1. On GH directly: https://github.com/storybookjs/storybook/blob/test-update-link/docs/configure/overview.md
  2. In development gatsby (on this branch if you have that branch checked out in the monorepo).
  3. In built gatsby (on this branch similarly).

Note there is some kind of negative interaction between our styles and those of gatsby-remark-autolink-headers -- there are lots of options to customize this -- I will leave that up to others ;)

@tmeasday tmeasday requested a review from jonniebigodes July 31, 2020 09:10
@jonniebigodes
Copy link
Contributor

i was checking the pr and with that i kinda had a homer simpson moment (pardon the bad pun). I checked locally the next branch and looked at the gatsby-config.js file and saw that the .md extensions will be stripped down.

Styling wise the plugin doesn't offer much possibilities. We have a way to include icons and assign a classname to the header and that's it. This is something that needs to be checked a bit more thoroughly.

@tmeasday
Copy link
Member Author

tmeasday commented Aug 1, 2020

@domyen lmk what styling you want for these auto links

@kylesuss
Copy link
Collaborator

kylesuss commented Aug 4, 2020

Done in #126 w/ styling as well. Thanks!

@kylesuss kylesuss closed this Aug 4, 2020
@kylesuss kylesuss deleted the add-autolinking branch August 4, 2020 15:41
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

Successfully merging this pull request may close these issues.

3 participants