Skip to content

Commit 6773d44

Browse files
ksw2000ksw2000
committed
Prepare v0.0.2
1 parent c9d241a commit 6773d44

File tree

6 files changed

+175
-2405
lines changed

6 files changed

+175
-2405
lines changed

‎.github/workflows/gitpage.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ jobs:
1919
run: |
2020
npm ci
2121
tsc
22-
node bin/index.js -s ./example
22+
node dist/index.js -s ./example
2323
- name: commit and push
2424
run: |
2525
cd output

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,4 @@ typings/
7676
.fusebox/
7777

7878
output/
79-
bin/
79+
dist/

‎README.md‎

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
# HackMD to HTML cli
1+
# hackmd-to-html-cli
22

3-
![](https://img.shields.io/github/workflow/status/liao2000/HackMD-to-HTML/publish?style=flat-square)
3+
![](https://img.shields.io/github/workflow/status/liao2000/HackMD-to-HTML/CI?style=flat-square)
44
[![NPM version](https://img.shields.io/npm/v/hackmd-to-html-cli.svg?style=flat-square)](https://www.npmjs.org/package/hackmd-to-html-cli)
55

66
A simple Node.js wrapper for `markdown-it`. This tool helps to convert HackMD markdown files to HTML files.
77

8-
> See DEMO: [https://liao2000.github.io/HackMD-to-HTML/](https://liao2000.github.io/HackMD-to-HTML/)
9-
108
## Install
119

1210
```sh
1311
npm install -g hackmd-to-html-cli
1412
```
1513

14+
See demo: [https://liao2000.github.io/HackMD-to-HTML/](https://liao2000.github.io/HackMD-to-HTML/)
15+
1616
## Usage
1717

1818
```sh
@@ -38,7 +38,6 @@ $ hmd2html -s file1.md file2.md file3.md
3838
$ hmd2html -s ./dir1 ./dir2
3939

4040
# files or directories
41-
4241
$ hmd2html -s file1.md ./dir1
4342
```
4443

@@ -50,18 +49,17 @@ $ hmd2html -s file1.md -d ./out
5049

5150
### Use custom layout
5251

53-
5452
```sh
5553
$ hmd2html -s hello.md -l ./myLayout.html
5654
```
5755

5856
+ /
59-
+ output
57+
+ output/ *generated*
6058
+ hello.html
6159
+ hello.md
6260
+ myLayout.html
6361

64-
**myLayout.html**
62+
**./myLayout.html**
6563
```html
6664
<html>
6765
<head></head>
@@ -71,12 +69,12 @@ $ hmd2html -s hello.md -l ./myLayout.html
7169
</html>
7270
```
7371

74-
**hello.md**
72+
**./hello.md**
7573
```markdown
7674
# hello
7775
```
7876

79-
**hello.html**
77+
**./output/hello.html**
8078
```html
8179
<html>
8280
<head></head>

0 commit comments

Comments
 (0)