3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-24 22:46:57 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: improve wording of using Markdown file paths (#6633)

Browse source 
* Update docs-markdown-features.mdx

* Author meant to recommend the use of full paths rather than relative paths: Technical edit
* Revised intro to naturally introduce the benefits of this recommendation: Style edit

* Update website/docs/guides/docs/docs-markdown-features.mdx

* Update website/docs/guides/docs/docs-markdown-features.mdx

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
This commit is contained in:
BigDataWriter 2022-02-07 19:12:38 -08:00 • committed by GitHub
parent 5db848f0e7
commit bd05b74808
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
website/docs/guides/docs/docs-markdown-features.mdx
View file

@ -29,7 +29,7 @@ Reference to another [document in a subfolder](subfolder/doc3.md).
:::tip :::tip
It is better to use relative file paths links instead of relative links: Using relative _file_ paths (with `.md` extensions) instead of relative _URL_ links provides the following benefits:
- links will keep working on the GitHub interface - links will keep working on the GitHub interface
- you can customize the document slugs without having to update all the links - you can customize the document slugs without having to update all the links