@@ -27,8 +27,8 @@ Usage: index [options]
27
27
28
28
Options:
29
29
-v, --version output the current version
30
- -s, --source < files_or_dirs...> specify the input markdown files or directories
31
- -d, --destination < path> specify the output directory (default: ./output)
30
+ -s, --src < files_or_dirs...> specify the input markdown files or directories
31
+ -d, --dest < path> specify the output directory (default: ./output)
32
32
-l, --layout < html_file> specify the layout file (default: " " )
33
33
-b, --hardBreak use hard break instead of soft break
34
34
-h, --help display help for command
@@ -99,7 +99,8 @@ See default layout here: https://github.com/ksw2000/hackmd-to-html-cli/blob/main
99
99
## Develop
100
100
101
101
1 . ` npm run lint ` to check the format of source code.
102
- 2 . ` npm test ` runs tests for this package, which generates result from ` ./example ` and places them in ` ./output ` .
102
+ 2 . ` npm run example ` runs example for this package, which generates result from ` ./example ` and places them in ` ./output ` .
103
+ 3 . ` npm test ` runs unit test files whose filenames end with ` .test.ts `
103
104
104
105
## Support
105
106
@@ -109,60 +110,60 @@ See default layout here: https://github.com/ksw2000/hackmd-to-html-cli/blob/main
109
110
110
111
HackMD fully supports syntax: [ features] ( https://hackmd.io/features-tw?both )
111
112
112
- | Features | hmd2html | HackMD Default Converter | |
113
- | ---------------| : ---------: | :--:| :--:|
114
- | ToC | ✅ | ✅ | |
115
- | Emoji | ✅ | ✅ | |
116
- | ToDo list | ✅ | ✅ | |
117
- | Code block | ✅ | ✅ | |
118
- | - Show line number or not | ✅ | ❌ | |
119
- | - Specify the start line number | ✅ | ❌ | v0.0.7⬆ |
120
- | - Continue line number | ✅ | ❌ | v0.0.8⬆ |
121
- | Blockquote | ✅ | ✅ | |
122
- | - specify your name | ✅ | ✅ | v0.0.10⬆ |
123
- | - specify time | ✅ | ✅ | v0.0.10⬆ |
124
- | - color | ✅ | ✅ | v0.0.10⬆ |
125
- | Render CSV as table | ✅ | ✅ | v0.0.10⬆ |
126
- | MathJax | ✅ | ✅ | |
127
- | Sequence diagrams | ✅ | ❌ | v0.0.5⬆ |
128
- | Flow charts | ✅ | ❌ | v0.0.5⬆ |
129
- | Graphviz | ✅ | ❌ | v0.0.7⬆ |
130
- | Mermaid | ✅ | ❌ | v0.0.5⬆ |
131
- | Abc | ✅ | ❌ | v0.0.7⬆ |
132
- | PlantUML | ✅ | ✅ | v0.0.10⬆ |
133
- | Vega-Lite | ✅ | ❌ | v0.0.7⬆ |
134
- | Fretboard | ✅ | ❌ | v0.0.11⬆ |
135
- | Alert Area | ✅ | ✅ | |
136
- | Detail | ✅ | ✅ | |
137
- | Spoiler container | ✅ | ✅ | v0.0.7⬆ |
138
- | Headers h1-h6 | ✅ | ✅ | |
139
- | Horizontal line| ✅ | ✅ | ` --- ` ` *** ` |
140
- | Bold | ✅ | ✅ | ` **b** ` ` __b__ ` |
141
- | Italic | ✅ | ✅ | ` *i* ` ` _i_ ` |
142
- | Deleted text | ✅ | ✅ | ` ~~del~~ ` |
143
- | Superscript | ✅ | ✅ | ` ^sup^ ` |
144
- | Subscript | ✅ | ✅ | ` ~sub~ ` |
145
- | Inserted text | ✅ | ✅ | ` ++ins++ ` |
146
- | Marked text | ✅ | ✅ | ` ==mark== ` |
147
- | Ruby case | ✅ | ✅ | |
148
- | Typographic<br >replacements | ✅ | ✅ | |
149
- | Blockquotes | ✅ | ✅ | |
150
- | List | ✅ | ✅ | |
151
- | Tables | ✅ | ✅ | |
152
- | Links | ✅ | ✅ | |
153
- | Link with title| ✅ | ✅ | |
154
- | Autoconverted link| ✅ | ✅ | |
155
- | Image | ✅ | ✅ | |
156
- | - normal | ✅ | ✅ | |
157
- | - with title | ✅ | ✅ | |
158
- | - given size | ✅ | ✅ | |
159
- | Footnotes | ✅ | ✅ | |
160
- | Definition list| ✅ | ✅ | |
161
- | Abbreviations | ✅ | ✅ | |
113
+ | Features | hmd2html | HackMD< br > Default Converter |
114
+ | --------------------------------- | :--:| :--:|
115
+ | ToC | ✅ | ✅ |
116
+ | Emoji | ✅ | ✅ |
117
+ | ToDo list | ✅ | ✅ |
118
+ | Code block | ✅ | ✅ |
119
+ | - Show line number or not | ✅ | ❌ |
120
+ | - Specify the start line number | ✅ | ❌ |
121
+ | - Continue line number | ✅ | ❌ |
122
+ | Blockquote | ✅ | ✅ |
123
+ | - specify your name | ✅ | ✅ |
124
+ | - specify time | ✅ | ✅ |
125
+ | - color | ✅ | ✅ |
126
+ | Render CSV as table | ✅ | ✅ |
127
+ | MathJax | ✅ | ✅ |
128
+ | Sequence diagrams | ✅ | ❌ |
129
+ | Flow charts | ✅ | ❌ |
130
+ | Graphviz | ✅ | ❌ |
131
+ | Mermaid | ✅ | ❌ |
132
+ | Abc | ✅ | ❌ |
133
+ | PlantUML | ✅ | ✅ |
134
+ | Vega-Lite | ✅ | ❌ |
135
+ | Fretboard | ✅ | ❌ |
136
+ | Alert Area | ✅ | ✅ |
137
+ | Detail | ✅ | ✅ |
138
+ | Spoiler container | ✅ | ✅ |
139
+ | Headers h1-h6 | ✅ | ✅ |
140
+ | Horizontal line ` --- ` ` *** ` | ✅ | ✅ |
141
+ | Bold ` **b** ` ` __b__ ` | ✅ | ✅ |
142
+ | Italic ` *i* ` ` _i_ ` | ✅ | ✅ |
143
+ | Deleted text ` ~~del~~ ` | ✅ | ✅ |
144
+ | Superscript ` ^sup^ ` | ✅ | ✅ |
145
+ | Subscript ` ~sub~ ` | ✅ | ✅ |
146
+ | Inserted text ` ++ins++ ` | ✅ | ✅ |
147
+ | Marked text ` ==mark== ` | ✅ | ✅ |
148
+ | Ruby case | ✅ | ✅ |
149
+ | Typographic<br >replacements | ✅ | ✅ |
150
+ | Blockquotes | ✅ | ✅ |
151
+ | List | ✅ | ✅ |
152
+ | Tables | ✅ | ✅ |
153
+ | Links | ✅ | ✅ |
154
+ | Link with title | ✅ | ✅ |
155
+ | Autoconverted link | ✅ | ✅ |
156
+ | Image | ✅ | ✅ |
157
+ | - normal | ✅ | ✅ |
158
+ | - with title | ✅ | ✅ |
159
+ | - given size | ✅ | ✅ |
160
+ | Footnotes | ✅ | ✅ |
161
+ | Definition list | ✅ | ✅ |
162
+ | Abbreviations | ✅ | ✅ |
162
163
163
164
### Support Externals
164
165
165
- | Features | hmd2html | HackMD Default Converter|
166
+ | Features | hmd2html | HackMD< br > Default Converter|
166
167
| -------------| :---------:| :---------:|
167
168
| Youtube | ✅ | ✅ |
168
169
| Vimeo | ✅ | ❌ |
0 commit comments