Skip to content

Commit e49e3b8

Browse files
committed
notes about markdown
1 parent c8fe691 commit e49e3b8

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

content/collections/06-about.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ Please keep these guidelines in mind for Digital Collection About pages:
1414
- Writing for the web is different from traditional documents. Use short paragraphs and plenty of headings. This facilitates reading and access on screen.
1515
- Always start with a h2 (`##`) level heading. The standard nav-menu include is designed to link to h2 level headings only.
1616
- Use meaningful text in hyperlinks (i.e. don't use pattern of "click here").
17+
- Don't use double spaces! These can get misinterpreted by Markdown engines and cause odd formatting.
1718

1819
Collection About Pages are written in Markdown.
1920
Below are some common notes about About pages for our Digital Collections.
@@ -41,7 +42,9 @@ All main sections will also be h2.
4142
Do not skip heading levels!
4243
Heading should follow hierarchically like an outline.
4344

44-
The "nav-menu" include is designed to provide links to the h2 sections.
45+
Always leave a blank line above and below a heading to ensure correct rendering.
46+
47+
The "nav-menu" include is designed to provide links to the h2 sections *only*.
4548

4649
`{% raw %}{% include feature/nav-menu.html sections="About CollectionBuilder;About the About Page" %}{% endraw %}`
4750

@@ -52,7 +55,7 @@ In the "sections" value, paste the exact text of each heading you want in the na
5255
## Citations
5356

5457
You'll need to cite the sources for your multimedia essay just as you would for any academic essay.
55-
Whenever possible, use [Turabian Style](https://www.chicagomanualofstyle.org/turabian/turabian-notes-and-bibliography-citation-quick-guide.html) to add your citations as footnotes.
58+
Whenever possible, use [Chicago Style / Turabian Style](https://www.chicagomanualofstyle.org/turabian/turabian-notes-and-bibliography-citation-quick-guide.html) to add your citations as footnotes.
5659

5760
To add a footnote in Markdown, directly after the sentence you'd like to cite, add a left square bracket (`[`), followed by a caret symbol (`^`), followed by a footnote number (i.e. `1`, `2`, `3`, etc.), followed by a left square bracket (`]`). See below for an example:
5861

@@ -82,7 +85,7 @@ You can create hyperlinks in Markdown like this:
8285
`[GitHub Help](https://help.github.com/)`
8386

8487
When linking to pages **within the same collection**, use Jekyll's `relative_url` feature.
85-
Instead of writing out https://www.lib.uidaho.edu on an About page you should use the Liquid relative_url formula.
88+
Instead of writing out https://www.lib.uidaho.edu you should use the Liquid relative_url formula.
8689

8790
**Don't** do this:
8891

0 commit comments

Comments
 (0)