Code Monkey home page Code Monkey logo

markdown2bootstrap's Introduction

Description

Converts a markdown file to a bootstrap-styled web page with a table of contents. It will figure out sections based on the headings used and calculate section numbers.

From this:

Markdown file

To this:

Bootstrap web page

Installing

$ npm install markdown2bootstrap

Usage

$ node_modules/.bin/markdown2bootstrap doc1.md doc2.md ...
Converted doc1.md to doc1.html
Converted doc2.md to doc2.html
...
$ cp -a node_modules/markdown2bootstrap/bootstrap ./

Notice that you can convert multiple files by specifying them on the command line.

Now open doc1.html in a web browser. You will notice that section numbers are automatically added along with a floating table of contents bootstrap-style. If you want to turn off section numbering use the -n option:

$ node_modules/.bin/markdown2bootstrap -n doc.md

The table of contents will still be created.

You can also turn on a bootstrap page header by passing -h. The header uses a title and a subtitle. You can specify them in the markdown document like this:

    <!-- title: This is a title -->
    <!-- subtitle: This is a subtitle -->

You should at least specify a title to give the webpage a proper html <title> tag.

Output

The converted files are created in the current directory by default with an extension of .html. You can specify a different output directory by using the --outputdir option:

$ node_modules/.bin/markdown2bootstrap --outputdir html doc.md
Converted  doc.md to html/doc.html

markdown2bootstrap's People

Contributors

renier avatar

Watchers

James Cloos 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.