msb-public
/
vitepress
mirror of https://github.com/vuejs/vitepress
2
1
Code Issues Projects Releases Wiki Activity

docs: modify README.md to index.md

Browse Source
pull/267/head
unknown 5 years ago
parent 673af524f6
commit 6baa3d4c49
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File

4
docs/guide/markdown.md
Unescape View File

@ -28,9 +28,9 @@ For example, given the following directory structure:
And providing you are in `foo/one.md`: And providing you are in `foo/one.md`:
```md ```md
[Home](/) <!-- sends the user to the root README.md --> [Home](/) <!-- sends the user to the root index.md -->
[foo](/foo/) <!-- sends the user to index.html of directory foo --> [foo](/foo/) <!-- sends the user to index.html of directory foo -->
[foo heading](./#heading) <!-- anchors user to a heading in the foo README file --> [foo heading](./#heading) <!-- anchors user to a heading in the foo index file -->
[bar - three](../bar/three) <!-- you can omit extention --> [bar - three](../bar/three) <!-- you can omit extention -->
[bar - three](../bar/three.md) <!-- you can append .md --> [bar - three](../bar/three.md) <!-- you can append .md -->
[bar - four](../bar/four.html) <!-- or you can append .html --> [bar - four](../bar/four.html) <!-- or you can append .html -->

Write Preview
Loading…
Cancel
Save