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: README.md
+16Lines changed: 16 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -165,13 +165,15 @@ When the markdown is translated to `html`, the single `\` disappears, which remo
165
165
#### Notes on paths and links
166
166
167
167
##### Relative paths in markdown files
168
+
168
169
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.
169
170
170
171
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.
171
172
172
173
A note about referencing `id` attributes in anchor links:
173
174
174
175
##### Referencing `id` attributes
176
+
175
177
Anchor links in markdown files can reference the following `id` attributes:
176
178
177
179
1.`id`s that are inside the same markdown file
@@ -183,6 +185,20 @@ They cannot, however, reference `id`s that are inside other markdown files.
183
185
184
186
##### Image paths on github.io
185
187
188
+
For simplicity between paths, a majority of images are referenced with their global path. An example of this path is displayed below.
On SimVascular's website, this will render correctly. However, if you have forked the simvascular.github.io and build and run the page through your github account, the images will not render correctly. This is because the fork you have made is a Project site instead of a User or Organization site. The difference between the two is detailed [here](https://www.tracktownsoftware.com/jekyll/github/2020/12/22/GitHubPagesUserVsProjectSites.html).
195
+
196
+
To still be able to view images, there are two options.
197
+
198
+
1. Rename your fork of simvascular.github.io to your_github_username.github.io to make your fork a User site instead of a Project site.
199
+
200
+
2. View your fork of the website from a local server instead of viewing it when it is deployed from your account with github pages.
201
+
186
202
#### Other notes for writing markdown
187
203
188
204
Markdown is sensitive to spaces and new lines. Headers without a space after the last "#" will not render correctly.
0 commit comments