Skip to content

Commit 401dd85

Browse files
committedJun 10, 2021
setup template with placeholders
1 parent 0a872b1 commit 401dd85

File tree

2 files changed

+123
-1
lines changed

2 files changed

+123
-1
lines changed
 

‎markdown-cheat-sheet.md

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Markdown Cheat Sheet
2+
3+
Thanks for visiting [The Markdown Guide](https://www.markdownguide.org)!
4+
5+
This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for [basic syntax](https://www.markdownguide.org/basic-syntax) and [extended syntax](https://www.markdownguide.org/extended-syntax).
6+
7+
## Basic Syntax
8+
9+
These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements.
10+
11+
### Heading
12+
13+
# H1
14+
## H2
15+
### H3
16+
17+
### Bold
18+
19+
**bold text**
20+
21+
### Italic
22+
23+
*italicized text*
24+
25+
### Blockquote
26+
27+
> blockquote
28+
29+
### Ordered List
30+
31+
1. First item
32+
2. Second item
33+
3. Third item
34+
35+
### Unordered List
36+
37+
- First item
38+
- Second item
39+
- Third item
40+
41+
### Code
42+
43+
`code`
44+
45+
### Horizontal Rule
46+
47+
---
48+
49+
### Link
50+
51+
[Markdown Guide](https://www.markdownguide.org)
52+
53+
### Image
54+
55+
![alt text](https://www.markdownguide.org/assets/images/tux.png)
56+
57+
## Extended Syntax
58+
59+
These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.
60+
61+
### Table
62+
63+
| Syntax | Description |
64+
| ----------- | ----------- |
65+
| Header | Title |
66+
| Paragraph | Text |
67+
68+
### Fenced Code Block
69+
70+
```
71+
{
72+
"firstName": "John",
73+
"lastName": "Smith",
74+
"age": 25
75+
}
76+
```
77+
78+
### Footnote
79+
80+
Here's a sentence with a footnote. [^1]
81+
82+
[^1]: This is the footnote.
83+
84+
### Heading ID
85+
86+
### My Great Heading {#custom-id}
87+
88+
### Definition List
89+
90+
term
91+
: definition
92+
93+
### Strikethrough
94+
95+
~~The world is flat.~~
96+
97+
### Task List
98+
99+
- [x] Write the press release
100+
- [ ] Update the website
101+
- [ ] Contact the media

‎template.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,22 @@
1-
This is the release notes template
1+
# release notes and genomes pages templates
2+
This file has suggested templates for:
3+
4+
- [initial subsite release](#initial-release-template)
5+
- [subsequent updates](#update-templates)
6+
- [genome pages](#genome-page-template)
7+
8+
Copy/paste what you need into a file in the appropriate subdirectory with a file name like this `display name---YYYY-MM-DD.md`
9+
## initial release template
10+
- [ ] create the template here
11+
12+
## update templates
13+
create templates here for
14+
15+
- [ ] genomes
16+
- [ ] variation data
17+
- [ ] pathways
18+
- [ ] expression data
19+
- [ ] tools
20+
21+
## genome page template
22+
- [ ] create the template here

0 commit comments

Comments
 (0)
Please sign in to comment.