Skip to content

Commit 2d70db0

Browse files
committed
readme: document relative path-based links
1 parent a49817b commit 2d70db0

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,19 @@ $ make build
2323
```
2424

2525
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26+
27+
### Guidelines
28+
29+
When using relative links, please make sure they are path-based, and not URL-based.
30+
31+
❌ Bad:
32+
```markdown
33+
[Blueprint](../overview/blueprint)
34+
```
35+
36+
✅ Good:
37+
```markdown
38+
[Blueprint](../01-overview/blueprint.md)
39+
```
40+
41+
This follows Docusaurus' guidance, see [their docs](https://docusaurus.io/docs/markdown-features/links) for more information.

0 commit comments

Comments
 (0)