Skip to content

Commit 96055e8

Browse files
authored
Update README.md
1 parent b669911 commit 96055e8

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,14 +162,16 @@ For this reason, the way LaTex is written in markdown differs slightly from the
162162

163163
When the markdown is translated to `html`, the single `\` disappears, which removes the ability to properly convert the LaTex with Mathjax. By making the single `\` a double `\\`, when the markdown is translated, the `html` will have a single `\`, which will properly render.
164164

165-
#### How to write the paths and links
165+
#### Notes on paths and links
166166

167+
##### Relative paths in markdown files
167168
When the markdown file is rendered using the `<zero-md>` element, the element translates the file to `html`, which is read directly when viewing the `html` page. For this reason, the paths in the markdown files should be written relative to the `html` page, not relative to the markdown file.
168169

169170
For example, in the `template` markdown files, which is placed in multiple folders, the path to the `quickguide.html` file would normally be "../../quickguide.html". However, because the file is rendered into an `html` page that will be next to the `quickguide.html` page, you should write the path as only "quickguide.html." This is because "quickguide.html" is the path relative to the `html` page into which the markdown will be translated.
170171

171172
A note about referencing `id` attributes in anchor links:
172173

174+
##### Referencing `id` attributes
173175
Anchor links in markdown files can reference the following `id` attributes:
174176

175177
1. `id`s that are inside the same markdown file
@@ -179,6 +181,8 @@ Anchor links in markdown files can reference the following `id` attributes:
179181

180182
They cannot, however, reference `id`s that are inside other markdown files.
181183

184+
##### Image paths on github.io
185+
182186
#### Other notes for writing markdown
183187

184188
Markdown is sensitive to spaces and new lines. Headers without a space after the last "#" will not render correctly.

0 commit comments

Comments
 (0)