Giter VIP home page Giter VIP logo

mkmd's Introduction

mkmd

Make Markdown from HTML web page.

What is this?

Time to time I need to save some excerpts or full text articles from a web pages into my personal wiki (which is a directory of plain markdown files basically). So to streamline this process this utility was born. It uses Mozilla's Radability.js to strip non-essential parts of a web page and leave just a making sense content. It runs from Rust with help of QuickJS. Since CommonMark Spec is huge, Rust binary already uses JS VM and there is Turndown that has proven itself for many years in converting HTML to Markdown, I decided to save some time and just use it. This tool, by default, downloads a page, makes it readable, converts HTML to Markdown and embed images as data URIs at the very end of the output file.

Usage examples

# Download, save, and cat with bat
$ mkdm "https://buttondown.email/hillelwayne/archive/i-am-disappointed-by-dynamic-typing/" | tee dyntype.md | bat -lmd

# Select in Firefox part that you'd like to save, right click and `View Selection Source`, capy and...
$ pbpaste | mkmd > ~/wiki/excerpt.md

# Do not embed images and do not use Readability.js
$ xsel -b | mkmd --no-img --full --output full-article.md

Install

Clone, cd and cargo build.

Play

$ git clone --recurse https://github.com/makovich/mkmd
$ cd mkmd
$ npm install
$ git apply --directory=src/readability --apply ./src/0001-data-nodeValue-API-to-comply-with-domino.patch
$ npm run test
$ npm bundle
$ cargo run

License

MIT/Unlicensed

mkmd's People

Watchers

Belarustianin avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.