Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

markitdown

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

markitdown

Convert GFL (github flavored markdown) to html using pandoc.

  • 0.0.4
  • latest
  • npm
  • Socket score

Version published
Weekly downloads
51
decreased by-42.7%
Maintainers
1
Weekly downloads
 
Created
Source

markitdown

A thin wrapper around pandoc to help you convert markdown into web pages.

Dependencies

  1. Node.js (http://nodejs.org/)
  2. Pandoc (http://johnmacfarlane.net/pandoc/installing.html)

Install

$> npm install markitdown -g

Usage

Convert markdown to html courtesy of pandoc.
Files will be written with the same name and a .html exension

Usage: markitdown inputFile.md


Options:
  --output-path  Output path.                                  
  --head         file to be included in <head>                 
  --header       file to be included just after opening <body> 
  --footer       file to be included just before end of </body>
  --title        prepend <title> tags with this value
  --docTemplate  file to be used instead of default pandoc template
  --version      output version and exit

Examples

As basic as it gets. Convert a single file to html. This will output readme.html.

$> markitdown readme.md

Convert the markdown files in the ./docs directory to html and put the output in the ./docsweb directory.

$> markitdown ./docs --output-path ./docsweb

Convert a single file to html, but insert html content into the top of the page. Useful for common navigation, headers, logos, etc.

$> markitdown readme.md --header ./header.html

Sample output

Wouldn't that be nice! Will add some to the gh-pages branch in the future.

FAQs

Package last updated on 07 Dec 2012

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc