3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-03 19:32:35 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix(utils): do not resolve Markdown paths with @site prefix (#6489)

Browse source
This commit is contained in:
Joshua Chen 2022-01-28 10:10:39 +08:00 • committed by GitHub
parent 8a912c708e
commit 556f59b193
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 5 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
website/docs/advanced/routing.md
View file

@ -75,6 +75,8 @@ Throughout the documentation, we always try to be unambiguous about whether we a
When writing links in Markdown, you could either mean a _file path_, or a _URL path_, which Docusaurus would use several heuristics to determine.
- If the path has a `@site` prefix, it is _always_ an asset file path.
- If the path has an `http(s)://` prefix, it is _always_ a URL path.
- If the path doesn't have an extension, it is a URL path. For example, a link `[page](../plugins)` on a page with URL `/docs/advanced/routing` will link to `/docs/plugins`. Docusaurus will only detect broken links when building your site (when it knows the full route structure), but will make no assumptions about the existence of a file. It is exactly equivalent to writing `<a href="../plugins">page</a>` in a JSX file.
- If the path has an `.md(x)` extension, Docusaurus would try to resolve that Markdown file to a URL, and replace the file path with a URL path.
- If the path has any other extension, Docusaurus would treat it as [an asset](../guides/markdown-features/markdown-features-assets.mdx) and bundle it.