0.0.1 • Published 1 year ago

hello-md-log v0.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

hello-md-log

GitHub npm version install size npm downloads

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 in mdconfig.json
  • you can change name with command line --username arguments or change mdconfig.json file.
  • you can set up the title with command line --title argument or change template/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/ by yyyy-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.