-
Notifications
You must be signed in to change notification settings - Fork 0
/
readme.txt
50 lines (31 loc) · 1.48 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
This readme is to explain what is the readme.md file
----------------------------------------------------------------
readme.md is a regular text file with Markdown syntax,
https://en.wikipedia.org/wiki/Markdown
Markdown is used in code repositories to add additional formatting,
such as headings, bold words, or hyper-links
For example the following creates a Heading Levels 1, 2, and 3:
# Header Level 1
## Header Level 2
### Header Level 3
and the next line makes the word "bold" in bold ("strong") lettering
This sentence contains a **bold** word in it.
----------------------------------------------------------------
To view the md files you can use any text editor to see the raw text.
If you search for Markdown viewers you can find a number of tools that
will render the final formatting of the .md file
The following are some markdown viewers that are provided for convenience.
They are not endorsed by the USGS, nor does the order indicate any order of preference.
* Read the files on the the git hosting website
--Such as code.usgs.gov or gitlab.com
* Typora Markdown Editor
https://typora.io/
* Mark Text (open source markdown editor)
https://marktext.app/
* Notepad++
https://notepad-plus-plus.org/ with the Plugin MarkdownViewer++
--Install the plugin under the Plugin menu by selecting "Plugin Admin"
* https://stackedit.io/
--Web Browser Interface
--Have to either upload markdown file or copy and paste text into browser.
--They do offer an offline download.