We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent a49817b commit 2d70db0Copy full SHA for 2d70db0
README.md
@@ -23,3 +23,19 @@ $ make build
23
```
24
25
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
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