mark2jek

🏠 mark2jek - markdown to jekyll converter

Replace markdown syntax with jekyll/html for compatibility

Install

npm install -g mark2jek

Basic Usage

format: [mark2jek/m2jek inputFile(relative) new=newName(optional)]. for example:

mark2jek index.md                  //overwrites input file
m2jek docs/readme.md new=page   //output will be docs/page.md

by default all flags are enabled, you can change your preset with the config changer, or specify flags on a single run

interactive config changer:

m2jek setup / config

Example of github workflow using this package for automatic gh-pages releases when main/README.md is changed:

custom-electron-prompt/main/.github/workflows/update-github-pages.yml

List Of Commands

version check

mark2jek --version

Flags

You can specify flags when executing a task.(case insensitive) each flag can have a few variant names, but you can always prepend no to disable the flag (except new= where you have) (these method always overwrite the flags set in the config) for example:

mark2jek index.md --raw
mark2jek index.md --noRaw new=pg.md --pics

Full list:

• --new=FILENAME or new=FILENAME - creates new file with FILENAME to disable:

  • with set just input nothing like m2jek set new=
  • in setup input delete/disable/false/no/n/x or just space

• --pics or --images- convert ![](x) to <img src=x>

• --nestedUrl or --nested - convert [![](x)](y) to <a href=y><img src=x></a>

• --githubRaw or --raw - convert github images to raw version

• --collapsible or --expand - adds an icon for collapsible content

• --codeblock or --liquid - replace:

   ```languageName
   codeblock lines
   ```‎
  

  with:

   {% highlight languageName %}
   codeblock lines
   {% endhighlight %}

Config

you can save settings as permanent flags in the config

all the following commands are to be used when not specifying a file to work on

interactive config changer

m2jek setup / config

show all commands (including flags)

m2jek list / help

show flags

m2jek flags

individually set flags

m2jek set noCodeblock nested noCollapsible [flags without --]

Author

👤 Araxeus

• Github: @Araxeus

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2021 Araxeus.
This project is MIT licensed.

---

Doesn't work if markdown have code blocks without language specified