https://github.com/araxeus/mark2jek
Replace markdown syntax with jekyll/html for compatibility
https://github.com/araxeus/mark2jek
Last synced: 21 days ago
JSON representation
Replace markdown syntax with jekyll/html for compatibility
- Host: GitHub
- URL: https://github.com/araxeus/mark2jek
- Owner: Araxeus
- License: mit
- Created: 2021-05-17T02:15:42.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-05T11:23:09.000Z (over 1 year ago)
- Last Synced: 2025-04-06T03:13:52.555Z (21 days ago)
- Language: JavaScript
- Size: 51.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🏠 mark2jek - markdown to jekyll converter
> Replace markdown syntax with jekyll/html for compatibility
## Install
```sh
npm install -g mark2jek
```
## Basic Usage
format: [`mark2jek`/`m2jek` `inputFile`(relative) `new=newName`(optional)]. for example:
```sh
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:
```sh
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](https://github.com/Araxeus/custom-electron-prompt/blob/main/.github/workflows/update-github-pages.yml)
## List Of Commands
#### version check
```sh
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:
```sh
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 `` to `
`
* `--nestedUrl` or `--nested` - convert `[](y)` to ``
* `--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:
```liquid
{% 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
```sh
m2jek setup / config
```
#### show all commands (including flags)
```sh
m2jek list / help
```
#### show flags
```
m2jek flags
```
#### individually set flags
```sh
m2jek set noCodeblock nested noCollapsible [flags without --]
```
## Author
👤 **Araxeus**
* Github: [@Araxeus](https://github.com/Araxeus)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/Araxeus/mark2jek/issues).
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2021 [Araxeus](https://github.com/Araxeus).
This project is [MIT](https://github.com/Araxeus/mark2jek/blob/main/LICENSE) licensed.
***
> Doesn't work if markdown have code blocks without language specified