Lightweight Markdown Documentation System
JavaScript CSS HTML Shell Makefile
Switch branches/tags
Nothing to show
Clone or download
Latest commit 2659009 Mar 30, 2017
Permalink
Failed to load latest commit information.
css Add ability to embed youtube videos easily Mar 27, 2017
docs Update features.md Mar 27, 2017
js Fix MathJax Bug Mar 29, 2017
scripts Update Feb 29, 2016
templates Update Jun 23, 2016
ver Update ditto.js Mar 30, 2017
.gitignore Publish mdoc for the first time :) Apr 18, 2014
Makefile Update May 10, 2015
README.md Update README.md Aug 2, 2016
index.html Add ability to embed youtube videos easily Mar 27, 2017
sidebar.md Update sidebar.md Mar 27, 2017

README.md

ditto

ditto inspired by flatdoc is a markdown code documentation system, capable of producing documentation similar to Three.js and Backbone.js, check out live demo here. It is designed for people who use Github Pages to host their code documentation, but you can also host it yourself.

You want to use ditto because

  • Docs are in markdown
  • No build process needed (markdown files are rendered on the browser)
  • Deployable via GitHub Pages

How do I start?

Enter the following command and follow instructions:

curl -L https://git.io/v6T7r > install.sh && sh install.sh

Or alternatively see this page for instructions.

LICENSE

The MIT License (MIT)

Copyright (c) 2014 Chris Choi

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.