Giter Club home page Giter Club logo

bashdown's Introduction

bashdown

markdown to html converter with bash as templating language, written in 100% pure bash, macgyver-style documentation generator

Usage

$ cat foo.md | bashdown
(produces markdown with evaluated values)

$ cat foo.md | bashdown --html
(evaluates template and produces html)

That will turn this into :

why

  • to quickly write documentation
  • portable
  • unlimited possibilities
  • markdown is nice, but has no template engine
  • bash is a fullfledged template engine already
  • everybody uses bash
  • its installed everywhere

requirements

  • BASH!
  • bashfu ninjaskills (its worth the investment..really)

Installation

mkdir ~/bin 
cd /tmp
git clone https://github.com/coderofsalvation/bashdown.git
git clone https://github.com/chadbraunduin/markdown.bash
cp markdown.bash/markdown.sh ~/bin/markdown
cp bashdown/bashdown ~/bin/.

Custom Markdown Chain

The '--html' makes usage of github's markdown processor, but you can use your own. In the 'example' directory you can see a simple wrapper which turns an markdown document into a nice styled html-document like so:

./mybashdown example.md > example.html

see the output here

Note

Put this in ~/.profile so you always have handson-access to your bashscripts in ~/bin:

 PATH="$HOME/bin:$PATH"

bashdown's People

Contributors

coderofsalvation avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Forkers

marciopocebon

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.