chutsu / ditto Goto Github PK

Lightweight Markdown Documentation System

CSS 31.42% Shell 1.16% HTML 11.06% JavaScript 55.92% Makefile 0.44%

ditto's Introduction

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)

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.

ditto's People

Contributors

Stargazers

Watchers

ditto's Issues

Use Bower package manager for JS scripts

As discussed in #9, @ConnorAtherton has suggested we use a package manager to keep track of JavaScript dependencies. This issue aims to integrate that into the project.

Reloading index.html causes "Uncaught TypeError"

I have a simple site set up (gh-pages branch of https://github.com/hartzell/ditto-exploration, http://hartzell.github.io/ditto-exploration/). The sidebar has a link at the top to return to the main page, stolen shamelessly from the ditto site.

# [de]()

Using Chrome on a mac, if I go to the main page, http://hartzell.github.io/ditto-exploration/, there are no errors in the javascript console. If I click on the 'de' link in the top of the sidebar, I get an "Uncaught TypeError message in the console.

It doesn't seem to have any particularly ill effects, but seems to be a bit messy.

mdoc

Hi,

There's already a well established project using mdoc as one of its names.

Could you rename your project to avoid the confusion, please?

Kind regards,

rjc

404 not found

Maybe there's something wrong with the url git.io/vUWYz.

all i got is 404 from it.

curl -L http://git.io/vUWYz > install.sh && sh install.sh
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0
0 0 0 0 0 0 0 0 --:--:-- 0:00:02 --:--:-- 0
100 15 100 15 0 0 4 0 0:00:03 0:00:03 --:--:-- 48
install.sh: 1: install.sh: 404:: not found

Ditto ver 11 not found

Pages using v 11 are getting:

Failed to load resource: the server responded with a status of 404 (Not Found)
http://chutsu.github.io/ditto/ver/0.11/highlight_8.0.min.js Failed to load resource: the server responded with a status of 404 (Not Found)
http://chutsu.github.io/ditto/ver/0.11/google_code.css Failed to load resource: the server responded with a status of 404 (Not Found)

I think it would be clearer if:

the ditto documentation reminded us that only the master branch is searched; and
either the language constraint is dropped or made optional or configurable.

I've created an orphan gh-pages branch, following the GitHub recipe.

I was confused when searching via the searchbox didn't find any of my pages.

A bit of googling reminded me that they only index the repo's default branch ("master").

Since I wasn't sure that GitHub indexed markdown files I created a perl file on the master branch, but search was unable to find it.

A quick scan of ditto.js revealed that the actual search (for "Foo") looks like this:

https://api.github.com/search/code?q=Foo+in:file+language:markdown+repo:hartzell/ditto-exploration

This doesn't find anything because of the "language:markdown" constraint.