https://github.com/m-zubairahmed/cleave-markdown

A simple tool to chunk large markdown to small based on custom identifier
https://github.com/m-zubairahmed/cleave-markdown

markdown nodejs npm-package splitter

Last synced: 25 days ago
JSON representation

A simple tool to chunk large markdown to small based on custom identifier

• Host: GitHub
• URL: https://github.com/m-zubairahmed/cleave-markdown
• Owner: M-ZubairAhmed
• License: mit
• Created: 2017-12-18T01:24:02.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-28T13:59:21.000Z (almost 7 years ago)
• Last Synced: 2024-10-07T23:36:10.559Z (29 days ago)
• Topics: markdown, nodejs, npm-package, splitter
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/cleave-markdown
• Size: 109 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



Cleave-Markdown 


[![NPM](https://nodei.co/npm/cleave-markdown.png?mini=true)](https://nodei.co/npm/cleave-markdown/) [![npm version](https://badge.fury.io/js/cleave-markdown.svg)](https://badge.fury.io/js/cleave-markdown) [![Build Status](https://travis-ci.org/M-ZubairAhmed/cleave-markdown.svg?branch=master)](https://travis-ci.org/M-ZubairAhmed/cleave-markdown)

_A markdown splitter tool for slicing coderplex learn guides to small markdown files based on custom identifier_

### Installation

`npm install --save-dev cleave-markdown`

### Usage

`./node_modules/.bin/cleave-markdown`

### Running

#### Directory path

This is a required option. Include the path to markdown guide file.

`./node_modules/.bin/cleave-markdown --file ~/sampleGuide.md`

#### Verbose output

Optional argument that displays the folder structure `cleave-markdown` has created from the guide file.

`./node_modules/.bin/cleave-markdown --file ~/sampleGuide.md --verbose`