medium_publish - Publish draft articles from Markdown to Medium

This little CLI application is used internally by Adatas to export our articles as draft into Medium. It is generic enough to be usable and shall be easy to customize to your fit custom needs. It run as a Node.js application and the source code is written in CoffeeScript

Installation

For users not familiar with the Node.js environment, you can follow the official installation instructions to get started and have the node, npm and npx command available on your system.

This package is published on NPM. Once Node.js is installed, it could be installed and executed with:

# Installation
npm install -g medium_publish
# Print help
npx medium_publish -h

The help print:

NAME
  medium_publish - Post draft articles on Medium

SYNOPSIS
  medium_publish [medium_publish options]

OPTIONS
     --author               The name of the author. Required.
     --author_url           URL of the author page.
     --db                   Path to the database, default to "~/.medium_publish"
  -h --help                 Display help information
     --langs                Accepted languages
     --source               Path to the Mardown source code of the article. Required.
     --url                  URL where the article is currently being published. Required.

EXAMPLES
  medium_publish --help     Show this message

Example

Use npx medium_publish if installed globally or locally as a dependency. Otherwise, from inside a cloned repository, use ./bin/medium_publish.

npx medium_publish \
  --source ./path/to/article.md \
  --url http://www.adaltas.com/en/my_article/ \
  --author 'Author Name' \
  --author_url http://www.adaltas.com/en/author/name/ \
  --langs en,fr

Plugins

Note, for conveniency, external plugins can be installed and declared by their package name or declared with medium_publish/plugins/external/{package_name}.

• remark-read-frontmatter
  Parse frontmatter and insert the "frontmatter" field in the vfile object.
• remark-public-images
  Upload every image present on the markdown article into a public GIT repository and update the src image attribute to reflect the new public URL.

Developer

Test are executed with Mocha and Should.js:

yarn test

Versioning and changelog generation use the standard-version package:

npm run release
# Or
npm run release --prerelease beta

Note, it does not push and publish. After release, run:

npm run publish

TODO: integrate CI/CD, publish from there.