Getting Started

Prerequisites

Node.js 18 or later
A Medium account export (request one from medium.com/me/export)

Run with npx (recommended)

No installation needed:

npx medmark

On first run medmark will:

Create a medmark/ workspace in your current directory
Walk you through a short interactive prompt

Install globally

npm install -g medmark
# or
pnpm add -g medmark

Then run:

medmark

Providing your Medium export

Request your export

Go to medium.com/me/export and request your information. Medium emails you a download link, which can take a little while to arrive.

Create the workspace

npx medmark init

Drop the posts in

Unzip the archive and copy its posts/ folder into medmark/medium-export/, so you end up with medmark/medium-export/posts/*.html.

Convert

npx medmark

First run walkthrough

┌
  ███╗   ███╗███████╗██████╗ ...
  ...
       Convert your Medium export to Markdown

◇  Path to the `posts` folder of your Medium export
│  medmark/medium-export/posts
│
◇  Destination folder for output files
│  medmark/output
│
◇  Configure advanced options?
│  No
│
◆  Configuration
│  Input     medmark/medium-export/posts
│  Output    medmark/output
│  Template  built-in default
│  Drafts    no
│  Skip      none
│  Debug     no
└
◇  Conversion complete!

What you get

medmark/output/
├── my-first-post/
│   └── index.md             ← one folder per post (folderForEachSlug)
├── registry.json            ← content registry manifest
└── conversion_report.json   ← what succeeded, failed, and was skipped

Prompts can be skipped

Every prompt has a matching flag, so the whole run can be scripted. See the CLI reference.

Getting Started

On this page