ruanyf / ditto

Lightweight Markdown Documentation System

ditto

ditto inspired by flatdoc is a markdown code documentation system, capable of producing documentation similar to Three.js and Backbone.js. It is designed for people who use Github Pages to host their code documentation, but it can easily be adapted for other use cases (it only consists of html, css, and javascript after all).

• No build process needed
• Deployable via GitHub Pages
• Can fetch more than just the README file
• Just create an HTML file, create some markdown files and deploy! :)

Live Demo here

Features

• Auto-generation of Page Anchors
• Edit button to Github pages
• Scroll back to top button

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.