Code Monkey home page Code Monkey logo

mdtohtml's Introduction

md-to-html-with-hljs-script

About

This is a simple script that uses highlight js and markdowns native markdown to html converter to turn md files into viewable web pages More info on markdown can be found here I built this to sovle the problem of not retaining syntax highlight when converting markdown to html.


Install

Markdown

This script was made with markdown 1.0.1-6 and hljs 8.2

markdown can be installed via

pacman -S markdown
yum install perl-Text-Markdown.noarch
apt-get install markdown

Hljs

Highlight.js can be installed from their download page

A custom package can be built for specified syntax.

Configure

The hljs js folder will need to be put into a directory that is accessible by the web server and declared within: header.html

Run

To run the script it is as simple as

$ ./cmd.sh source_directory target_directory

This will create a web ready html file that imports hljs and replaces the syntax with the appropriate html tags along with some custom stylings for each md file in the source directory. The outputs will have the same name but with a index.html extension in the output directory.


mdtohtml's People

Contributors

pietdaniel avatar

Stargazers

Kevin Hatfield avatar

Watchers

James Cloos avatar  avatar  avatar

Forkers

cloudxtreme

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.