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

Page-to-page Markdown document links are not working #1137

Closed
markerikson opened this issue Dec 3, 2018 · 1 comment · Fixed by #1138
Closed

Page-to-page Markdown document links are not working #1137

markerikson opened this issue Dec 3, 2018 · 1 comment · Fixed by #1138
Assignees
Labels
bug An error in the Docusaurus core causing instability or issues with its execution

Comments

@markerikson
Copy link

markerikson commented Dec 3, 2018

🐛 Bug Report

Summary: In-page links such as [some link text](./SomeFile.md) are not getting turned into actual links to the final HTMl page.

Have you read the Contributing Guidelines on issues?

Yes

To Reproduce

A couple months ago, we set up the initial Docusaurus config for Redux. That's been sitting on a branch since then, and I'm just now poking around at it further.

The Redux docs have numerous inter-page links. Examples from the current docs:

In our test deploy site at https://redux-docs.netlify.com , it looks like most or all of the internal links are broken.

  1. Clone the Redux repo at https://github.com/reduxjs/redux
  2. Check out the docs-rebuild branch, specifically as of commit reduxjs/redux@944df4a
  3. Start Docusaurus
  4. Inspect internal links such as those pages, and note that they point to something like /basics/Actions.md, instead of /basics/actions, even though the /docs/basics/Actions.md file has an ID, has been added to the sidebar, and is correctly linked from the sidebar.

Expected behavior

Simple Markdown file links would resolve correctly to the generated page URLs.

Actual Behavior

Markdown links are still pointing to the original file name in the brackets.

Note that this may be related to #1094 .

@endiliey endiliey self-assigned this Dec 3, 2018
@endiliey endiliey added the bug An error in the Docusaurus core causing instability or issues with its execution label Dec 3, 2018
@reintroducing
Copy link

so i published my first docs page for an OSS project i'm doing and finally today pushed it out to production. ran into this as well, the sidebars seem to be linking fine but a path in the actual docs themselves did not. for instance, in tasks-home.md i'd have a link [creating](tasks-creating) which would then try to take me to tasks-home/tasks-creating. i even tried to disable cleanUrl in the siteConfig because I noticed if i went to tasks-home.html then the link worked correctly.

looking at the generated output in the build folder, docusaurus creates tasks-home.html and /tasks-home/index.html. Its within these index files that the linking is incorrect while the [page].html variants seem to work fine, but no matter what the setting is for cleanUrl, I can't get to those [page].html pages unless i 1) use the sidebar or 2) go directly to their URLs. every internal page to page link is broken, though.

its also worth noting that this all works locally before publishing, too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug An error in the Docusaurus core causing instability or issues with its execution
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants