Skip to content

Commit f322697

Browse files
author
Michael Andrew Auer
committed
Update README and release markdown-parse 0.1
1 parent 3c088f2 commit f322697

1 file changed

Lines changed: 29 additions & 1 deletion

File tree

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,38 @@
22
Python based Markdown to HTML parser
33

44
## Usage
5-
For now at least:
5+
##### Running the script
66
```shell
77
python3 mdparse.py note.md
88
```
9+
##### Current Limitations of the Parser
10+
- Currently, the parser reads each line of your markdown one at a time so you can only use one kind of styling per line
911

1012
## Markdown Spec
1113
The initial version will be based off of the [Daring Fireball Spec](http://daringfireball.net/projects/markdown/basics)
14+
15+
## Supported Markdown
16+
##### Header tags using '#' notation from \<h1\> to \<h6\>
17+
```markdown
18+
# H1 Title
19+
```
20+
##### Bold text using asterisks or underscore notation
21+
```markdown
22+
**Bold Text** __Bold Text__
23+
```
24+
##### Italic text using asterisks or underscore notation
25+
```markdown
26+
*Italic text* _Italic text_
27+
```
28+
##### Code blocks i.e.
29+
```markdown
30+
``console.log('markdown is awesome!');``
31+
```
32+
##### Images (Alt text, Image URL)
33+
```markdown
34+
![alt text here](http://thecatapi.com/?id=bsb)
35+
```
36+
##### Links (Link Text, Link URL)
37+
```markdown
38+
[View Markdown Parse on Github][https://github.com/auermi/markdown-parse]
39+
```

0 commit comments

Comments
 (0)