Skip to content

Commit f46088b

Browse files
authored
Update template.md
1 parent ff4dc9e commit f46088b

File tree

1 file changed

+17
-8
lines changed

1 file changed

+17
-8
lines changed

template.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Symbiota Docs Documentation Style Guide
2-
Please refer to and update this style guide to help maintain consistency across the user documentation for [Symbiota](https://github.com/BioKIC/Symbiota).
2+
Please refer to and update this style guide to help maintain consistency and readability across the user documentation for [Symbiota](https://github.com/BioKIC/Symbiota).
33

44
## Page-level Frontmatter
5-
Each page in Symbiota Docs should contain the following elements, some of which format the citation that appears at the bottom of each page:
5+
Each page in Symbiota Docs should contain the following elements, some of which format the citations on the bottom of each page:
66
```
77
title: "Page Title in Title Case"
88
date: 20XX-MM-DD
@@ -12,7 +12,7 @@ authors: ["Firstname Lastname"]
1212
keywords: ["x", "y", "z", "etc"]
1313
```
1414
- `date` should refer to the first day that the page was created, not modified (see below).
15-
- Title values shoule be succicent and often reflect an action, e.g. "Deleting Records".
15+
- Title values should be succicent and often reflect an action using a gerund, e.g. "Deleting Records".
1616

1717
If a page is modified, add values for `lastmod` and `editors`:
1818
```
@@ -40,10 +40,10 @@ Or to add tips:
4040
{{</ notice >}}
4141
```
4242

43-
Use _italics_ for
43+
Use _italics_ for:
4444
- Filenames, e.g. _identifications.csv_
4545
- Names of columns/fields, e.g. _Additional Identifier Value_ or _basisOfRecord_
46-
- File and navigation paths, paired with carrots, e.g. _My Profile > Occurrence Management > Administration Control Panel_ or _Sitemap > Additional Resources > Glossary_
46+
- File and navigation paths paired with carrots, e.g. _My Profile > Occurrence Management > Administration Control Panel_ or _Sitemap > Additional Resources > Glossary_
4747

4848
Use quotation marks `"..."` when referencing:
4949
- Example values, e.g. "PreservedSpecimen"
@@ -56,9 +56,18 @@ Use capitalization for:
5656
Use **bold** for:
5757
- emphasis, e.g. "Before batch editing, remember to **backup your dataset**".
5858

59+
For code and commands:
60+
- Format shorter code snippets with \`...\`, e.g. `bundle exec jekyll serve`.
61+
- More extensive code and commands can be recorded à la:
62+
```
63+
{{< highlight batchfile >}}
64+
cd Documents/symbiota-docs/
65+
hugo server -D
66+
{{< /highlight >}}
67+
```
68+
5969
Additionally:
60-
- Top-level headings within documentation pages should use `##` and should generally use title case.
61-
- Format code snippets with \`...\`, e.g. `bundle exec jekyll serve`.
70+
- Top-level headings within documentation pages should use `##` and generally should be written in title case.
6271
- File extensions written as part of a filename are lowercase, e.g. *example.jpg*, but when written alone are uppercase, e.g. "The file should be a JPG."
6372

6473
## Including Media
@@ -94,5 +103,5 @@ Image files should be named descriptively in lowercase. Do not use any character
94103

95104
## Related Resources
96105
- [GitHub Formatting Syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
97-
- [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
106+
- [Markdown Guide's Cheatsheet](https://www.markdownguide.org/cheat-sheet/)
98107
- [Markdown Emojis Directory](https://gist.github.com/rxaviers/7360908)

0 commit comments

Comments
 (0)