Skip to content

ff6347/to-markdown-cli

Folders and files

NameName
Last commit message
Last commit date
Apr 27, 2023
Sep 21, 2024
Apr 27, 2023
Apr 27, 2023
Apr 27, 2023
Apr 27, 2023
Mar 9, 2023
Apr 27, 2023
Sep 11, 2018
Mar 9, 2023
Apr 27, 2023
Apr 27, 2023
Jan 9, 2025
Sep 21, 2024
Jul 21, 2023
Sep 21, 2024
Apr 27, 2023
Mar 9, 2023
Sep 21, 2024
Sep 21, 2024
Mar 9, 2023
Mar 9, 2023
Mar 9, 2023
Apr 6, 2023

Repository files navigation

to-markdown-cli

All Contributors Node CI npm GitHub last commit FOSSA Status

Installation

npm install -g to-markdown-cli

Usage

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

Troubleshooting

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.

Contributors

Thanks goes to these wonderful people (emoji key):

roose
roose

💻
Fabian Morón Zirfas
Fabian Morón Zirfas

💻
cayhorstmann
cayhorstmann

🐛
akomakom
akomakom

📖 🐛
thenbe
thenbe

🤔

This project follows the all-contributors specification. Contributions of any kind welcome!

Test

npm run test

Acknowledgements

Build on these great modules:

Related Projects