npm install -g to-markdown-cli
Usage: html2md [options]
Options:
-V, --version output the version number
-i, --input <input> path to the input file (if input is stdin) it will be ignored
-o, --output <output> path to the output file
-c, --clipboard use only the clipboard for input and output
-g, --gfm use GitHub Flavored Markdown
-h, --help output usage information
_ _ _ _ _ _ _
/ \ / \ / \ / \ / \ / \ / \
( h | t | m | l | 2 | m | d )
\_/ \_/ \_/ \_/ \_/ \_/ \_/
html2md turns html into markdown
- if no input file is given it ueses the clipboard content
- if no output file is given it logs the result to stdout
- if there is input from stdin clipboard will be ignored for inputs
Examples:
$ html2md -i ./foo.html # output to stdout
$ html2md -i ./foo.html -o out.md # output to out.md
$ html2md -o out.md # clipboard to out.md
$ html2md -c # clipboard to clipboard
$ html2md # clipboard to stdout
$ html2md -g # clipboard to stdout using GitHub flavored markdown
$ echo "<h1>foo</h1>" | html2md # will output to stdout
Acknowledgments:
Build on these great modules:
- https://github.com/domchristie/turndown
- https://github.com/sindresorhus/clipboardy
- https://github.com/tj/commander.js
The following error indicates that $DISPLAY is not set to a valid display: Error: Both xsel and fallback failed
html2md relies on a valid $DISPLAY because it uses clipboard via xsel.
In some environments (for example, tmux) you may need to run the command as follows:
DISPLAY=:0 html2md ... # or whatever your display id is.
Fully headless systems may not be able to use html2md.
Thanks goes to these wonderful people (emoji key):
roose 💻 |
Fabian Morón Zirfas 💻 |
cayhorstmann 🐛 |
akomakom 📖 🐛 |
thenbe 🤔 |
This project follows the all-contributors specification. Contributions of any kind welcome!
npm run testBuild on these great modules:
- domchristie/turndown: An HTML to Markdown converter written in JavaScript
- sindresorhus/clipboardy: Access the system clipboard (copy/paste)
- tj/commander.js: node.js command-line interfaces made easy
- suntong/html2md: HTML to Markdown converter https://github.com/suntong/html2md
- JohannesKaufmann/html-to-markdown: ⚙️ Convert HTML to Markdown. Even works with entire websites and can be extended through rules. https://github.com/JohannesKaufmann/html-to-markdown
- thebigbone/markhtml: a fast CLI tool for converting markdown to html https://github.com/thebigbone/markhtml
- letmutex/htmd: A turndown.js inspired HTML to Markdown converter for Rust https://github.com/letmutex/htmd
- romansky/dom-to-semantic-markdown: DOM to Semantic-Markdown for use in LLMs https://github.com/romansky/dom-to-semantic-markdown