You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
lurkdown is a markdown transpiler that was built on nodejs with typescript to create standalone html files. lurkdown converts all locally hosted image files to base64 to avoid dealing with images when we want to host that html files somewhere. I mainly developed this to convert my markdown formatted notes to html and then use them like static blog posts. lurkdown is a command line tool. I will make a *library* version that will be usable in web and nodejs projects later.
`lurkdown` is a command-line markdown transpiler tool that was built on `NodeJS` with `TypeScript` to create standalone, markdown-generated HTML files. `lurkdown` converts all locally hosted image files to `base64` to avoid dealing with images when we want to host that HTML files at somewhere. *It is not perfect but works in most cases.*
6
14
7
15
8
16
9
17
## installation
10
18
11
19
You can directly install via npm
12
20
21
+
22
+
13
23
```
14
24
npm i -g lurkdown
15
25
```
16
26
27
+
28
+
17
29
Or you can download the standalone executable version.
--files // mandatory. specify file paths by enclosing with quotes and seperating with commas.
42
-
e.g. --files='./path/to/file.md, ./path/to/file2.md, ./path/to/file3.md'
55
+
-`--theme` / __*optional*__ -> Available themes: dark, light. If you don't specify a theme, output files will be exported without any styling.
43
56
44
-
--titles // optional. specify the titles that will be used in <title></title> tag in html files. they should be specified in the same order as files and as like files they should be enclosed with quotes and sepeated with commas.
-`--titles` / __*optional*__ -> Specify the titles that will be used in `title` tag in output files. They should be specified in the same order as files and they should be enclosed with quotes and then separated with commas.
--outdir // optional. if you don't specify a output directory, files will be exported in same directory as like input files.
60
+
-`--outdir` / __*optional*__ -> If you don't specify an output directory, files will be exported in same directory as like input files.
48
61
49
-
--styles // optional. specify the custom css file paths if you want to customize the outputed html files. they are specified like files and titles. enclose with quotes and seperate with commas.
50
-
e.g. --styles='./path/to/cssfile.css, ./path/to/cssfile2.css'
62
+
-`--styles` / __*optional*__ -> Specify the custom `CSS` file paths If you want to customize the output files. They should be specified like files and titles. Enclose with quotes and then separate with commas.
lurkdown --theme=dark --files='./src/test/http_notes.md, ./src/test/post.md' --titles='HTTP Notes, My First Blog Post' --outdir=./export --favico=./src/icon.ico
62
75
```
63
76
64
77
65
78
66
-
Or you can just pass a sing config.json file with the `--config`.
79
+
Or you can just pass a single `config.json` file with the `--config` parameter.
You can customize the elements by using this css class names.
110
+
You can customize the elements by using this `CSS` class names.
111
+
112
+
96
113
97
114
```css
98
115
.ld-wrapper { }
@@ -133,5 +150,6 @@ You can customize the elements by using this css class names.
133
150
.ld-td { }
134
151
```
135
152
136
-
lurkdown uses [highlight.js](https://github.com/highlightjs/highlight.js) to deal with syntax highlighting so if you want to customize the syntax highlighting, you can pass the [customized css files](https://highlightjs.org/static/demo/) with the `--styles` parameter.
153
+
---
137
154
155
+
`lurkdown` uses [highlight.js](https://github.com/highlightjs/highlight.js) to deal with syntax highlighting so if you want to customize the syntax highlighting, you can pass the [customized css files](https://highlightjs.org/static/demo/) with the `--styles` parameter.
0 commit comments