Giter VIP home page Giter VIP logo

markdownconverter's Introduction

Markdown to HTML

A quick script to convert a directory of Markdown to HTML. Requires the html-pipeline and github-markdown gems.

How it Works

The script will go through the src directory and verify all the links work correctly (they should be relative. The assumption is that the src directory is something like documentation / requirements). It will then convert the Markdown files to their HTML equivalents, putting them in the doc folder.

Each time the script runs, everything in the doc folder is deleted and recreated.

Example Usage

The src directory in the repository has been compiled to the doc directory, with the following output:

ianmitchell@~/code/MarkdownConverter$ ruby compile.rb
Checking for invalid links...
	There is a broken link in table.md: "contents.md"
Changing to milestones/...
Changing to tools/...
Done!

There were errors when checking the links; continue anyways? (y/n) y
Compiling milestones/...
Compiling tools/...
Done! Your HTML documentation is now in `/doc`.

markdownconverter's People

Contributors

ianmitchell avatar

Stargazers

Stuart Macgregor avatar

Watchers

 avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.