Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Bad-ass infrastructure for javascript libraries
CoffeeScript JavaScript

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
test
vendor
.gitignore
.npmignore
README.md
index.js
package.json

README.md

  _________.__
 /   _____/|  |__   ______  _  __ ____ _____    ______ ____
 \_____  \ |  |  \ /  _ \ \/ \/ // ___\\__  \  /  ___// __ \
 /        \|   Y  (  <_> )     /\  \___ / __ \_\___ \\  ___/
/_______  /|___|  /\____/ \/\_/  \___  >____  /____  >\___  >
        \/      \/                   \/     \/     \/     \/

          Bad-ass infrastructure for javascript libraries.

How to use

Well configured express server for documentation, tests and so on

It uses express, so you can extend it as you like. Check default configuration

app = require('showcase').app(__dirname)
app.get '/', (req, res) ->
  res.render 'examples/index'

app.start()

Easy authentication with github

app = require('showcase').app(__dirname)
app.configure 'production' ->
  app.set('github-client-id', 'id')
  app.set('github-client-secret', 'secret')

Generate documentation with docco

docco = require('showcase').docco
docco(files: '/src/*', output: '/public/docs', root: __dirname, layout: 'linear')
Something went wrong with that request. Please try again.