Update readme
This commit is contained in:
parent
86aa021db7
commit
e84b04449e
1 changed files with 13 additions and 10 deletions
23
README.md
23
README.md
|
@ -1,15 +1,18 @@
|
||||||
# packmd
|
# buildmd
|
||||||
|
|
||||||
To install dependencies:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
bun install
|
|
||||||
```
|
```
|
||||||
|
buildmd - Build markdown files to html with templates and metadata
|
||||||
|
|
||||||
To run:
|
Usage:
|
||||||
|
buildmd file.md
|
||||||
|
buildmd file.md -o output.html
|
||||||
|
echo "some markdown" | buildmd
|
||||||
|
|
||||||
|
Options:
|
||||||
|
--outfile, -o <file> Output file path
|
||||||
|
--template, -t <file> Template file path
|
||||||
|
--stylesheet, -s <file> Stylesheet file path
|
||||||
|
--stdout Force output to stdout
|
||||||
|
--help, -h Show this help message
|
||||||
|
|
||||||
```bash
|
|
||||||
bun run index.ts
|
|
||||||
```
|
```
|
||||||
|
|
||||||
This project was created using `bun init` in bun v1.2.12. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue