See on github

Introduction

 

Introduction

Bibliosoph is a base website written with Node/Express that let you quickly create awesome looking documentation for your projects. It is a compilation of the best practices found in documentations over the web.

Reponsive
It adapts to all displays: computer, tablet, phone...
Themable
You can chose from colorful themes and create your own.
 

Get started

There is two ways to get started: Yeoman and Git. We recommend you use Yeoman as it is a cleaner install as it doesn't come with all the views of Bibliosoph and will guide you into populating the config.json.

 

Using Yeoman (recommended)

  • Install yeoman
  • Install the bibliosoph generator
  • Create a directory and cd into it
  • Create a new blank bibliosoph project
  • Start server

Then go to http://localhost:5000/ (or the port number you configured) and tadam! It's time to customize it to your needs.

npm install -g yo grunt-cli
npm install -g generator-bibliosoph
mkdir my-documentation-website & cd $_
yo bibliosoph
node app.js
 

Using Git

  • Clone the project github repo
  • Install module
  • Start server

Then go to http://localhost:5000/ (or the port number you configured) and tadam! It's time to customize it to your needs.

git clone git@github.com:pillars/bibliosoph.git my-documentation-website
cd my-documentation-website & npm install
node app.js
 

Changelog

0.4.0 - August 10th 2013

  • Make it themable
  • Make it responsive
  • Improve the css

0.3.0 - June 27th 2013

  • Add Element: REST API docs
  • Update URL hash when scrolling
  • Simplify the repository URL configuration
  • Add an optional "Powered by Bibliosoph" link

0.2.0 - June 2nd 2013

  • Add connect-asset to handle js and css files
  • Add syntax highlighting using highlight.js
  • Add Elements: blocks, notes, JSFiddle, Github, FAQ

0.1

First version.

 

MIT License

Do what you want with this. Feel free to contribute, fork, love, hate...

Credits

Bibliosoph takes his inspiration from various documentation projects like Stripe, Github documented source, Symfony, Posterous...

The icons used come from TWG.