Code Monkey home page Code Monkey logo

cnvrtdwn_js's Introduction

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

cnvrtdwn_js's People

Watchers

 avatar  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.