Sha256: 5bb6cda4f4c908cebfd96172c6dfbec38e3e7aaa63658e37d96d9330381876fc

Contents?: true

Size: 1.36 KB

Versions: 19

Compression:

Stored size: 1.36 KB

Contents

# 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.

Version data entries

19 entries across 19 versions & 1 rubygems

Version Path
gitdoc-4.5.0 README.md
gitdoc-4.4.0 README.md
gitdoc-4.3.0 README.md
gitdoc-4.2.0 README.md
gitdoc-4.1.0 README.md
gitdoc-4.0.0 README.md
gitdoc-3.13.0 README.md
gitdoc-3.10.0 README.md
gitdoc-3.8.0 README.md
gitdoc-3.7.0 README.md
gitdoc-3.6.2 README.md
gitdoc-3.6.1 README.md
gitdoc-3.6.0 README.md
gitdoc-3.5.0 README.md
gitdoc-3.4.0 README.md
gitdoc-3.3.0 README.md
gitdoc-3.2.0 README.md
gitdoc-3.1.0 README.md
gitdoc-3.0.0 README.md