Migrate content from Medium using the supplied zip file, and generate a zip
file you can import into a Ghost installation.
To install the CLI, which is required for the Usage commands below:
npm install --global @tryghost/migrate
To use this package in your own project:
npm install @tryghost/mg-medium-export --save
or
yarn add @tryghost/mg-medium-export
To run a Medium migration, the required command is:
migrate medium --pathToZip /path/to/my-export.zip
Note: The zip path can be to a singular zip file or a folder of zip files
It's possible to pass more options, in order to achieve a better migration file for Ghost:
-
--pathToZip
(required)- Path to a zip file
- string - default:
null
-
-V
--verbose
- bool - default:
false
- Show verbose output
- bool - default:
-
--zip
- bool - default:
true
- Create a zip file
- bool - default:
-
-s
--scrape
- Configure scraping tasks
- string - default:
all
- Choices:
all
,img
,web
,media
,files
,none
-
--sizeLimit
- number - default:
false
- Media files larger than this size (defined in MB [i.e.
5
]) will be flagged as oversize
- number - default:
-
-e
--email
- string - default:
false
- Provide an email domain for users e.g. example.com
- string - default:
-
--addTag
- string - default:
null
- Provide a tag name which should be added to every post in this migration (Wrap in single quotes if tag name has spaces
'Like This'
)
- string - default:
-
--addPlatformTag
- Add #medium tag to migrated content
- bool - default:
true
-
--mediumAsCanonical
- bool - default:
false
- Use medium article as canonical URL
- bool - default:
-
--removeResponses
- bool - default:
true
- Remove response posts such as comments from the output
- bool - default:
-
--fallBackHTMLCard
- bool - default:
true
- Fall back to convert to HTMLCard, if standard Mobiledoc convert fails
- bool - default:
-
--cache
- Persist local cache after migration is complete (Only if
--zip
istrue
) - bool - default:
true
- Persist local cache after migration is complete (Only if
A more complex migration command could look like this:
migrate medium --pathToZip /path/to/my-export.zip --email example.com
This will process all posts from the zip file, and all authors will have an email address ending in 'example.com'
This is a mono repository, managed with lerna.
Follow the instructions for the top-level repo.
-
git clone
this repo &cd
into it as usual - Run
yarn
to install top-level dependencies.
To run a local development copy, cd
into this directory, and use yarn dev
instead of migrate
like so:
yarn dev medium --pathToZip /path/to/my-export.zip
-
yarn lint
run just eslint -
yarn test
run lint and tests
Copyright (c) 2013-2023 Ghost Foundation - Released under the MIT license.