You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+9-2Lines changed: 9 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -96,7 +96,7 @@ The _Docsify_ site is served from the `docs` directory with restrictions on link
96
96
97
97
As usual external resource can be linked e.g. `https://example.com`.
98
98
99
-
**Rules for internal links**
99
+
#### Rules for internal links
100
100
101
101
DocsifJS will render markdown links in your docs as appropriate paths in the DocsifyJS structure.
102
102
@@ -114,8 +114,15 @@ Apply these rules to the latter part of markdown URLs such as `[Text](page.md)`.
114
114
- Do not refer to content outside of the `docs` directory. e.g. `../README.md`.
115
115
- If you use relative links between files in the `docs` directory - make sure to enable this in the app config.
116
116
117
+
#### HTML links
117
118
118
-
!> Be careful when using HTML tags that have links or avoid them. <br>HTML tag hyperlinks will be rendered literally and so will break in the Docsify path structure e.g. `foo.md` or `foo.md#my-project`. <br> You can set them up manually, which makes them harder to maintain if your site structure changes. e.g. `href="/#/id=my-project"` or `href="/#/foo.md?id=my-project"`
119
+
!> Be careful when using HTML tags that have links or avoid them.
120
+
121
+
HTML tag hyperlinks will be rendered literally and so will break in the Docsify path structure e.g. `foo.md` or `foo.md#my-project`.
122
+
123
+
You can set them up manually, which makes them harder to maintain if your site structure changes. e.g. `href="/#/id=my-project"` or `href="/#/foo.md?id=my-project"`.
124
+
125
+
Also note that the root prefix is needed for Docsify paths to work, but you'll also need to hardcode your repo name in which is fragile too. e.g. `href="/my-repo/#/id=my-project"`
0 commit comments