Skip to content

This is minimal markdown to html parser which can interprete any markdown input.

License

Notifications You must be signed in to change notification settings

comcy/cnvrtdwn_js

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CnvrtdwnJs

cnvrtdwn_js gives the possibility to read in markdown written texts and print them out as a html file.

Build Status npm version


Table of Contents


Example

cnvrtdwn -i ./path/to/my/README.md -o ./README.html 

Installation

  1. Install the package global or to your devDependencies
$ npm install -g | --save | --save-dev cnvrtdwn-js

Clone

Clone this repo to your local machine using https://github.com/comcy/cnvrtcrwlr_js.git

Setup

Install npm packages

$ npm install

Features

Planned features:

  1. More intelligent argument parsing
  2. Improve docs
  3. Add tests
  4. Error handling
  5. Preparation for static site generator

Usage

If you want to use the tool during a build process modify your package.json by adding a cnvrtdwn script to the scripts section

package.json

  ...
  "scripts": {
      ...
      "cnvrtdwn": "index.js"
  },
  ...

Documentation

TODO: Show docs

Tests

TODO: Add tests


Contributing

Commit issues under: https://github.com/comcy/cnvrtcrwlr_js/issues

Feel free to improve code via Pull Requests.


License

GitHub

About

This is minimal markdown to html parser which can interprete any markdown input.

Resources

License

Stars

Watchers

Forks

Packages

No packages published