gitdoc 2.0.0 → 3.0.0

data/README.md

@@ -0,0 +1,31 @@
+# GitDoc
+
+GitDoc is another attempt at a tiny content system.
+
+I mostly use it to share research notes with people I'm working with.
+
+You don't actually need to use git with it.
+
+Here's how you can use it to put some content on the internet:
+
+    mkdir resume
+    cd resume
+    gitdoc init
+    mate index.md
+    # then edit document
+    rake
+    # preview in browser
+    git init && git commit -m ''
+    heroku add
+    git push heroku master
+  
+My two primary goals with GitDoc are simplicity and stability. 
+
+Simplicity in the sense that the smallest GitDoc instance contains 4 files: `config.ru`, `Gemfile`, `Rakefile` and `index.md` and once you've filled `index.md` (and any other files you create) with your content the signal-to-noise ratio should be pretty high.
+
+Stability in the sense that you should be able to come back to a GitDoc instance 15 months later, type `rake` and see the content without too much fiddling with technology.
+
+There are literally hundreds of 'similar' projects to GitDoc. A couple that I like are:
+
+* [Gollum](https://github.com/github/gollum) - If you don't mind waiting after you've committed your changes to see them rendered then this thing is pretty cool. Power's the GitHub wikis.
+* [Brochure](https://github.com/sstephenson/brochure) - Supports partials and pages can be written in any [Tilt](https://github.com/rtomayko/tilt) based template language.

data/TODO

@@ -0,0 +1,6 @@
+* Open web browser after server launches
+* Less http logging
+* Fall back to rackup if no unicorn present
+* TomDoc the public API
+* A :scriptable option that supports script embedding and an /index.json call
+* Don't run the server on a port that's in use

data/VERSION

@@ -1 +1 @@
-2.0.0
+3.0.0

data/bin/gitdoc

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+version = File.read(File.dirname(__FILE__)+'/../VERSION')
+
+unless ARGV == ['init']
+  puts "GitDoc version #{version}"
+  puts "Run with 'init' to make the current directory a GitDoc instance"
+  exit
+end
+
+if File.exists? 'config.ru'
+  abort "config.ru exists, is GitDoc already set up for this folder?"
+end
+
+config = <<-END
+require 'gitdoc'
+
+GitDoc!
+END
+
+rakefile = <<-END
+require 'bundler/setup' unless $LOAD_PATH.detect { |p| p =~ /gitdoc$/ }
+require 'gitdoc/tasks'
+END
+
+gemfile = <<-END
+source :rubygems
+gem 'gitdoc', '#{version}'
+END
+
+index = <<-END
+Welcome to GitDoc
+END
+
+File.open('config.ru','w') { |f| f.write config }
+File.open('Rakefile','w') { |f| f.write rakefile }
+File.open('Gemfile','w') { |f| f.write gemfile }
+
+system 'bundle install'

data/default.sass

@@ -0,0 +1,94 @@
+*
+  font-family: Helvetica Neue
+
+body, pre, code
+  font-size: 14px
+  line-height: 20px
+  color: #333
+
+a
+  color: #333
+  text-decoration: underline
+
+h1, h2, h3, p, ul, ol, pre
+  margin: 20px 0
+
+h1,h2,h3
+  font-weight: bold
+
+// draws a block to the side to make long documents easier to scan and to
+// make it easier to recognise the heading level
+@mixin heading-hint ( $width)
+  position: relative
+  &:before
+    content: ''
+    display: block
+    width: $width
+    height: 10px
+    background: #e8e8e8
+    position: absolute
+    left: -15px - $width
+    top: 7px
+
+h1
+  font-size: 20px
+  @include heading-hint(30px)
+
+h2
+  font-size: 18px
+  @include heading-hint(25px)
+
+h3
+  font-size: 16px
+  @include heading-hint(20px)
+
+em
+  font-style: italic
+
+strong
+  font-weight: bold
+
+// GitDoc doesn't really support more than two levels of list nesting
+// If you have to do that you'll need to write your own styles
+
+li
+  margin: 10px 0
+
+li:before
+  float: left
+  margin-left: -44px
+  color: #666
+  width: 30px
+  text-align: right
+
+ul li:before
+  content: "*"
+  margin-top: 5px
+  font-size: 20px
+
+ul ul li:before
+  font-size: 15px
+  margin-top: 3px
+  margin-left: -45px
+  color: #999
+
+ol > li
+  counter-increment: ol-li
+ol li:before
+  content: counter(ol-li)
+
+ol ol li
+  counter-increment: ol-ol-li
+ol ol li:before
+  content: counter(ol-ol-li)
+
+ol ol li:before
+  font-size: 13px
+  color: #999
+
+ul ul, ol ol
+  margin: 0
+
+#doc
+  width: 600px
+  margin: 40px auto

data/gitdoc/tasks.rb

@@ -0,0 +1,11 @@
+task :server do
+  exec 'unicorn -r bundler/setup'
+end
+
+task :dev do
+  unless $LOAD_PATH.last =~ /gitdoc$/
+    abort "Run rake with the path to GitDocs's source to use dev mode\n"+
+          "Eg. rake -I ~/Projects/gitdoc dev"
+  end
+  exec "shotgun -I #{$LOAD_PATH.last}"
+end

data/gitdoc.rb

@@ -10,6 +10,7 @@ def GitDoc! title = nil, opts = {}
   set :styles, dir + '/styles.sass'
   set :title, title
   set :header, opts[:header]
+  set :default_styles, opts[:default_styles] != false
   run Sinatra::Application
 end
 
@@ -89,6 +90,7 @@ get '/.css' do
   content_type :css
   styles = sass(:reset)
   styles += File.read(settings.root + '/highlight.css')
+  styles += sass(:default) if settings.default_styles?
   styles += sass(File.read(settings.styles)) if File.exist? settings.styles
   styles
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gitdoc
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 7
   prerelease: false
   segments: 
-  - 2
+  - 3
   - 0
   - 0
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors: 
 - Myles Byrne
@@ -15,8 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-29 00:00:00 -06:00
-default_executable: 
+date: 2011-01-20 00:00:00 +11:00
+default_executable: gitdoc
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rdiscount
@@ -67,18 +67,24 @@ dependencies:
   version_requirements: *id003
 description: 
 email: myles@myles.id.au
-executables: []
-
+executables: 
+- gitdoc
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.md
+- TODO
 files: 
 - .gitignore
+- README.md
 - Rakefile
+- TODO
 - VERSION
+- bin/gitdoc
+- default.sass
 - doc.haml
 - gitdoc.rb
+- gitdoc/tasks.rb
 - highlight.css
 - reset.sass
 has_rdoc: true