Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 9b82d89

Browse files
Update README.md
1 parent d00d304 commit 9b82d89

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

docs/README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ The _Docsify_ site is served from the `docs` directory with restrictions on link
9696

9797
As usual external resource can be linked e.g. `https://example.com`.
9898

99-
**Rules for internal links**
99+
#### Rules for internal links
100100

101101
DocsifJS will render markdown links in your docs as appropriate paths in the DocsifyJS structure.
102102

@@ -114,8 +114,15 @@ Apply these rules to the latter part of markdown URLs such as `[Text](page.md)`.
114114
- Do not refer to content outside of the `docs` directory. e.g. `../README.md`.
115115
- If you use relative links between files in the `docs` directory - make sure to enable this in the app config.
116116

117+
#### HTML links
117118

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"`
119126

120127

121128
## Quickstart local server

0 commit comments

Comments
 (0)