Go to file
David Tesler 45118fd732
Merge pull request #11 from SkillFlowHQ/dependabot/npm_and_yarn/ws-5.2.3
Bump ws from 5.2.2 to 5.2.3
2021-11-26 15:06:27 -08:00
examples add backticks for code blocks 2019-12-23 22:55:37 -08:00
lib add backticks for code blocks 2019-12-23 22:55:37 -08:00
.gitignore add internal vscode files to gitignore 2019-12-23 22:19:07 -08:00
LICENSE add license 2017-04-28 17:28:22 -07:00
README.md add note on examples to readme 2019-12-23 22:55:57 -08:00
index.js add ability to run from command line 2019-12-22 15:11:27 -08:00
package-lock.json Merge pull request #11 from SkillFlowHQ/dependabot/npm_and_yarn/ws-5.2.3 2021-11-26 15:06:27 -08:00
package.json Added Bin to package.json [https://docs.npmjs.com/files/package.json#bin] 2020-09-01 10:15:16 +05:30

README.md

Medium to markdown

npm npm

This module lets you take a medium post and convert it to markdown.

Command Line Usage

Setup:

  1. Install npm if not already installed
  2. Clone the repo
  3. run npm install inside the repo

Outputting to command line:

npm run convert https://medium.com/@almenon214/keeping-yourself-motivated-as-a-coder-a16a6fcf49c7

Replace the link with the article you want to convert.

Outputting to file:

npm run convert https://medium.com/@almenon214/keeping-yourself-motivated-as-a-coder-a16a6fcf49c7 > exampleOutput.md

Replace the link with the article you want to convert.

What does the output look like?

See examples/exampleOutput.md for an example of what https://medium.com/@almenon214/keeping-yourself-motivated-as-a-coder-a16a6fcf49c7 looks like when converted to markdown.

API Usage

Currently, the module supports getting the markdown from a medium post by URL.

const mediumToMarkdown = require('medium-to-markdown');

mediumToMarkdown.convertFromUrl('<medium post url>')
.then(function (markdown) {
  console.log(markdown); //=> Markdown content of medium post
});