Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

medium-2-md

0.2.0 • Public • Published

medium-2-md

Converts medium posts (html) into Jekyll/Hugo compatible markdown files. Also extracts and adds yaml front matter to the converted markdown files. This package works with already exported Medium posts and also with post urls. It converts all exported posts to markdown using a single command. It is mainly useful in scenarios when you want to migrate your blog away from Medium to Jekyll or Hugo (or something similar which supports markdown content).

Steps to use

Convert local Medium exports

  1. Export and extract your Medium posts from your Medium account.
    1. Go to https://medium.com/me/settings and scroll to Download your information. Click the download button. This will give you a medium-export.zip archive containing all your Medium content.
    2. Extract the .zip archive downloaded in the previous step. It will have a sub-directory called posts.
    3. Copy the path of this posts directory.
  2. Install node.js and medium-2-md on your system.
    1. Download and Install node.js - https://nodejs.org/en/download/.
    2. Install medium-2-md - npm i -g medium-2-md.
  3. Run the following command to convert all your Medium posts (html) to markdown files,
medium-2-md convertLocal '<path of the posts directory>' -df

That's it. The output markdown files will be stored in a sub-directory called md_<a big number> in the input posts directory itself. (By the way, that big number is coming from the Date.now() JavaScript function added to differentiate the output folders in case we go crazy with it.)

The converted markdown files will have front matter which will have title, description, published date and canonical URL of the original Medium post/story.

Convert from post URL

The CLI tool can also be used to convert a single Medium post from it's url. It requires an additional parameter -o for output directory where the converted markdown file can be written. To convert a Medium post to markdown from it's url, run the following command after installing the npm package,

medium-2-md convertUrl '<url of the Medium post>' -o '<path of output directory>' -f

Optional flags

The convertLocal command supports the following optional flags,

  1. -d or --drafts which means if you want to convert the drafts too.
  2. -f or --frontMatter which means if you want to add the front matter on top of the markdown file.

The -f flag is supported by the convertUrl command also.

Example: Convert from local - drafts enabled

medium-2-md convertLocal E:\\path\\to\\posts\\dir -d

Example: Convert from local - front matter enabled

medium-2-md convertLocal E:\\path\\to\\posts\\dir -f

Example: Convert from url - front matter enabled

medium-2-md convertUrl https://medium.com/abcd/new-post-993fbe47 -o E:\\path\\to\\output\\dir -f

Note: The flags do not support any defaults. You need to add them in order to get the respective results (drafts and/or front matter inclusion).

Dependencies

This package uses:

  1. turndown - html to markdown conversion.
  2. cheerio - to select and extract relevant html attributes from Medium posts' html files.
  3. commander - to enable command line interface.
  4. js-yaml - to add yaml front matter to markdown files.
  5. request - to get Medium post body from its url.

install

npm i medium-2-md

Downloadsweekly downloads

7

version

0.2.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability