Skip to content

Commit 1d3cfa8

Browse files
committed
Update README.md
1 parent 78ba16d commit 1d3cfa8

File tree

1 file changed

+62
-64
lines changed

1 file changed

+62
-64
lines changed

README.md

Lines changed: 62 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -89,78 +89,76 @@ $ hmd2html -s hello.md -l ./myLayout.html
8989
## Develop
9090

9191
1. `npm run lint` to check the format of source code.
92-
2. `npm test` to test this package, which generates result from `./example` into `./output`.
92+
2. `npm test` runs tests for this package, which generates result from `./example` and places them in `./output`.
9393

9494
## Support
9595

9696
`hmd2html`: our tool (the latest)
9797

98-
`HackMD Online`: HackMD Online Editor
99-
100-
`HackMD Default Converter`: The default markdown to html converter provided by HackMD i.e., download HTML file on HackMD.
101-
102-
| Features | hmd2html | HackMD Online | HackMD Default Converter | |
103-
|---------------|:---------:|:-------:|:--:|:--:|
104-
| ToC |||||
105-
| Emoji |||||
106-
| ToDo list |||||
107-
| Code block |||||
108-
| - Show line number or not |||||
109-
| - Specify the start line number ||||v0.0.7⬆|
110-
| - Continue line number ||||v0.0.8⬆|
111-
| Blockquote |||||
112-
| - specify your name |||||
113-
| - specify time |||||
114-
| - color to vary the blockquoutes |||||
115-
| Render CSV as table |||||
116-
| MathJax |||||
117-
| Sequence diagrams ||||v0.0.5⬆|
118-
| Flow charts ||||v0.0.5⬆|
119-
| Graphviz ||||v0.0.7⬆|
120-
| Mermaid ||||v0.0.5⬆|
121-
| Abc ||||v0.0.7⬆|
122-
| PlantUML |||||
123-
| Vega-Lite ||||v0.0.7⬆|
124-
| Fretboard |||||
125-
| Alert Area |||||
126-
| Detail |||||
127-
| Spoiler container ||||v0.0.7⬆|
128-
| Headers h1-h6 |||||
129-
| Horizontal line|||| `---` `***`|
130-
| Bold |||| `**b**` `__b__`|
131-
| Italic |||| `*i*` `_i_`|
132-
| Deleted text |||| `~~del~~` |
133-
| Superscript |||| `^sup^` |
134-
| Subscript |||| `~sub~` |
135-
| Inserted text |||| `++ins++` |
136-
| Marked text |||| `==mark==` |
137-
| Ruby case |||| |
138-
| Typographic<br>replacements |||| |
139-
| Blockquotes |||| |
140-
| List |||| |
141-
| Tables |||| |
142-
| Links |||| |
143-
| Link with title|||||
144-
| Autoconverted link|||||
145-
| Image |||||
146-
| - normal |||||
147-
| - with title |||||
148-
| - given size |||||
149-
| Footnotes |||||
150-
| Definition list|||||
151-
| Abbreviations |||||
98+
`HackMD Default Converter`: The default markdown to html converter provided by HackMD, i.e., download HTML file on HackMD.
99+
100+
| Features | hmd2html | HackMD Default Converter | |
101+
|---------------|:---------:|:--:|:--:|
102+
| ToC ||||
103+
| Emoji ||||
104+
| ToDo list ||||
105+
| Code block ||||
106+
| - Show line number or not ||||
107+
| - Specify the start line number |||v0.0.7⬆|
108+
| - Continue line number |||v0.0.8⬆|
109+
| Blockquote ||||
110+
| - specify your name |||v0.0.10⬆|
111+
| - specify time |||v0.0.10⬆|
112+
| - color |||v0.0.10⬆|
113+
| Render CSV as table |||v0.0.10⬆|
114+
| MathJax ||||
115+
| Sequence diagrams |||v0.0.5⬆|
116+
| Flow charts |||v0.0.5⬆|
117+
| Graphviz |||v0.0.7⬆|
118+
| Mermaid |||v0.0.5⬆|
119+
| Abc |||v0.0.7⬆|
120+
| PlantUML |||v0.0.10⬆|
121+
| Vega-Lite |||v0.0.7⬆|
122+
| Fretboard ||||
123+
| Alert Area ||||
124+
| Detail ||||
125+
| Spoiler container |||v0.0.7⬆|
126+
| Headers h1-h6 ||||
127+
| Horizontal line||| `---` `***`|
128+
| Bold ||| `**b**` `__b__`|
129+
| Italic ||| `*i*` `_i_`|
130+
| Deleted text ||| `~~del~~` |
131+
| Superscript ||| `^sup^` |
132+
| Subscript ||| `~sub~` |
133+
| Inserted text ||| `++ins++` |
134+
| Marked text ||| `==mark==` |
135+
| Ruby case ||| |
136+
| Typographic<br>replacements ||| |
137+
| Blockquotes ||||
138+
| List ||||
139+
| Tables ||||
140+
| Links ||||
141+
| Link with title||||
142+
| Autoconverted link||||
143+
| Image ||||
144+
| - normal ||||
145+
| - with title ||||
146+
| - given size ||||
147+
| Footnotes ||||
148+
| Definition list||||
149+
| Abbreviations ||||
152150

153151
### Support Externals
154152

155-
| Features | hmd2html | HackMD Online | HackMD Default Converter|
156-
|-------------|:---------:|:-------:|:--:|
157-
| Youtube | | ||
158-
| Vimeo | | ||
159-
| Gist | | ||
160-
| SlideShare | | ||
161-
| Speakerdeck | | ||
162-
| PDF | | ||
163-
| Figma | | ||
153+
| Features | hmd2html | HackMD Default Converter|
154+
|-------------|:---------:|:---------:|
155+
| Youtube || |
156+
| Vimeo || |
157+
| Gist || |
158+
| SlideShare || |
159+
| Speakerdeck || |
160+
| PDF || |
161+
| Figma || |
164162

165163
### Support YAML Metadata
166164

0 commit comments

Comments
 (0)