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

Fix redirects in docs for previous urls #2843

Merged
merged 1 commit into from Feb 18, 2018
Merged

Fix redirects in docs for previous urls #2843

merged 1 commit into from Feb 18, 2018

Conversation

@markerikson
Copy link
Contributor

Cool, let's get this merged in now.

Per Tim's other comment, can you also fix the "Edit on Github" links to point to our main repo instead of your fork? Let's do that as a separate PR.

@markerikson markerikson merged commit f310026 into reduxjs:master Feb 18, 2018
@SamyPesse
Copy link
Contributor Author

The "Edit on GitHub" link still points to my repository because the GitBook space is still linked to my fork.

One of you (@markerikson or @timdorr ) needs to go to https://redux.js.org/~/settings/integrations (as a space admin) and setup the GitHub integration with this repository.

@SamyPesse
Copy link
Contributor Author

The previous urls are now working correctly: http://redux.js.org/docs/api/index.html 🎉

Let me know if you need help configuring the GitHub integration at https://redux.js.org/~/settings/integrations

You can ping me using the Intercom widget on https://beta.gitbook.com

@markerikson
Copy link
Contributor

Yep, sweet! Thanks for the quick fix and directions on the integration.

Now we just need the FAQ anchor links fixed up - you said that was something on your end?

@SamyPesse
Copy link
Contributor Author

The new GitBook is not generating raw HTML from the markdown parsing, but instead parse it as a semantic JSON document. HTML in markdown is stripped from the output.

You were using raw HTML (<a id="..."></a>) to have anchors in the document. But it's hacky because GitHub doesn't support to define custom IDs on headings.

Our markdown parser supports the Kramdown syntax for custom IDs: # Hello {#mycustom-id}. But it doesn't render well on GitHub.

I'll discuss this issue tomorrow with the rest of the team, and we'll come up with a solution that works for you. We'll probably extend our parsing to detect these <a id="..."></a> and reattach them to the headers; in that case it'll require no work on your end.

Anyway this is a common use-case and we should have a clear solution for it!

I'll keep you updated ASAP.

@markerikson
Copy link
Contributor

Yeah, I figured it was something like that. I'm fine with tweaking the way we define those links if there's a better option.

Appreciate you looking into this!

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.

None yet

2 participants