clojuredocs.org web app
Switch branches/tags
Nothing to show
Clone or download
Pull request Compare This branch is 25 commits ahead, 510 commits behind zk:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.pair.io
app
config
coverage
db
doc
public
script
test
vendor/plugins
.autotest
.gitignore
.rvmrc
Capfile
Gemfile
Gemfile.lock
README.md
Rakefile
epl-v10.html

README.md

Overtone Docs - a respectful fork of the ClojureDocs Web App

I wanted to contribute to the Overtone project by adding some documentation. The standard doc generators for Clojure didn't really cut it (no search for example) so I decided to fork this project instead. I happen to think it's one of the best documentation sites available, regardless of language or library, so I knew it would be a good fit.

There are a few Overtone specific changes but they're mostly cosmetic. The big change is changing from MySQL to Postgres and removing the Thinking Sphinx gem. This version of the site uses Postgres full-text search instead. It's hosted on Heroku and you can see it in action at http://overtone-docs.herokuapp.com.

ClojureDocs Web App

ClojureDocs is a community powered documentation and examples repository designed to aid clojurists of all skill levels in groking clojure core and third party libraries.

The alpha version of ClojureDocs was released on July 9th, 2010. See the original mailing list post for more information.

ClojureDocs consists of three main projects: this website, the library importer, and the external API.

Requirements

  • Ruby 1.8.7 & Rails 2.1.5.
  • Postgres
  • bundler
  • RVM - not required, but highly suggested.

Getting Started

  • Open up a terminal.
  • Clone the repo: git clone https://github.com/xavriley/clojuredocs.git
  • cd clojuredocs
  • update the config/database.yml file with your details
    • alternatively, set the environment variables for your database user:
    • export DBUSER=mypguser
    • export DBPASS=mypgpass
  • Install required gems: bundle install
  • Create the required databases: rake db:create
  • Run database migrations: rake db:migrate
  • Start the dev server: script/server
  • Navigate to http://localhost:3000

License

ClojureDocs is licensed under the EPL v1.0 http://opensource.org/licenses/eclipse-1.0.php