npm.io
0.4.0 • Published 12 years ago

showcase

Licence
Version
0.4.0
Deps
8
Vulns
8
Weekly
0
Stars
2
  _________.__
 /   _____/|  |__   ______  _  __ ____ _____    ______ ____
 \_____  \ |  |  \ /  _ \ \/ \/ // ___\\__  \  /  ___// __ \
 /        \|   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')