Giter Site home page Giter Site logo

docitup's Introduction

DocItUp (Documentation made easy)

A simple Dokumentation Generator based on Markdown. It's a python script so you have to have python 2.6 or greater installed. A sample style.css is included but feel free to restyle it. DocItUp relies on highlight.js for syntax highlighting.

usage

Just edit the settings.json file like so

{
	"project_name" : "MY PROJECT",
	"build_path" : "YOUR BUILD PATH",
	"hooks" : [["git", "add", "."],["git", "commit", "-am", "DocItUp"],["git", "push"]]
}

You can also pass a list of command in the hooks attribute. These commands will execute after the build process terminates.

docitup's People

Contributors

haithembelhaj avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

traedamatic

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.