bootmark

0.8.0 • Public • Published

Checkout the Waffle.io

compatibility

as seen on tv

version: 0.8.0

easy markdown + bootstrap

See some EXAMPLES

Read the DOCS

Read the CHANGELOG

This project was inspired by strapdown. Since strapdown hasn't been active for a while, I decided to take a stab at it.

some features:

  • adds easy latex math support thru the katex-latex extension
  • external files
  • all bootswatch themes (bootstrap 3)
  • optional automatic table of content
  • showdown parser (vanilla markdown)
  • custom templates
  • in active development

installation

yarn install

yarn add bootmark

npm install

npm install --save bootmark

bower install

bower install bootmark

development

make sure you have git and nodejs installed and set up

download

first clone the repo, cd into it, and checkout the development branch

git clone https://github.com/obedm503/bootmark.git && cd bootmark && git checkout development

install dependencies

for this I recommend you use yarn because it's faster, but you could also use npm

using yarn:

yarn install

OR using npm:

npm install

npm scripts

Note: bootmark used to depend on gulp for task running but now simply uses npm scripts.

  • docs - scans the source file and outputs documentation to docs/DOCS.md

    npm run docs
    
  • build:js - uglifies the source javascript file and generates source maps

    npm run build:js
    
  • build:css - compiles the source .scss file to .css and generates source maps

    npm run build:css
    
  • build - runs build:js and build:css

    npm run build
    
  • build:watch - starts development server on localhost:8080 and runs build on file changes in src/

    npm run build:watch
    
  • bundle - complies Sass, uglifies source js and concatenates all javascript files to create the bundle file. the bundle file includes: es6-promise polyfill, whatwg-fetch polyfill, jQuery, Bootstrap, Showdown, google-code-prettify, the showdown-prettify extension, and bootmark itself in that order

    npm run bundle
    
  • bundle:watch - starts development server on localhost:8080 and runs bundle on file changes in src/

    npm run bundle:watch
    
  • publish - generates docs, cleans dist/ and processes source files

    npm run publish
    
  • lint - lint source js file with ESLint with the style rules in .eslintrc.json

    npm run lint
    

Readme

Keywords

none

Package Sidebar

Install

npm i bootmark

Weekly Downloads

100

Version

0.8.0

License

MIT

Last publish

Collaborators

  • obedm503