GithubHelp home page GithubHelp logo

codynhanpham / markdown-to-html Goto Github PK

View Code? Open in Web Editor NEW
0.0 1.0 0.0 129 KB

A converter that takes markdown files and converts it to production-ready HTML for https://codynhanpham.com

Home Page: http://codynhanpham.com/markdown-to-html/

CSS 24.48% HTML 38.04% JavaScript 35.96% Shell 1.52%

markdown-to-html's Introduction

Markdown to custom HTML

A converter that takes markdown files and converts it to production-ready HTML for https://codynhanpham.com

โ†’ A real world demo of this README.md itself: https://codynhanpham.com/markdown-to-html

Features

  • Support class mapping that can select specific elements down the tree
  • Custom class can be specified in the markdown file for specific elements
  • Code syntax highlighting
  • Custom CSS styling (of course)
  • Customizable HTML templates
  • Customizable presets

Usage

See the code: css, presets, and index.js

It's for my personal webpage, though it's pretty straightforward to use. The default preset should work just fine for most cases.

Simply clone the repo, then npm install and node . [files ...] [options] to run the converter.

Files: A sequence of markdown files to convert.

Options:

  • -p, --preset <preset>: Use a preset. Default: default
  • -c, --classmap <classmap>: Use a classmap. Must be a JSON file. If specified, this class map will override the class map in preset. See presets/classMap/resume.json for examples. Default: default (blank)

Example:

node . README.md -p default -c classmap.json

markdown-to-html's People

Contributors

codynhanpham avatar

Watchers

 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.