0.0.1 ⢠Published 1 year ago
hello-md-log v0.0.1
hello-md-log
boilerplate from modern-npm-package
Get Started
š Hello Markdown Log š”
- currently using
template/markdown.md
for the md generator - it generates the following markdown for TIL format at
/docs/your-name/
path
# TIL: {{dateString}} // yyyy-mm-dd
---
## {{title}}, {{username}}
- use command line to generate the markdown file
- your name is
github username
by default, and save inmdconfig.json
- you can change name with command line
--username
arguments or changemdconfig.json
file. - you can set up the title with command line
--title
argument or changetemplate/markdown.md
file.
# CLI
$ npx hello-md-log
# arguments
--username dusunax
--title "Title Turtle"
CLI messages
š« Please set up your name first!
- Name is required for directory settings. You need to set username first. (it will be saved later in the config.json file)
ā
Created 2024-04-01.md
- Created a new md file at
/docs/your-name/
byyyyy-mm-dd.md
ā
Configuration saved
- New configuration is saved in config.json
š« "docs/dusunax/2024-04-01.md" already exists š
- Today's TIL file is already exist.
0.0.1
1 year ago