cmcc / nbviewer Goto Github PK

IPython notebook viewer is an heroku application that given the url of a IPython notebook file (ending in ipynb) show you a static html version.

If will need to have an heroku account, or have acces to one, just push the master branch :

git push heroku master:master

The application will be availlable under yourappname.herokuapp.com

The app is based on Twitter Bootstrap so you will need some dependency like node,uglify-js.

• everything in /static/ is serve statically
• html files in /static/ are build from /template/ by doing $ make in the root dirrectory
• /template/layout.mustache contain headers and footers
• every *.mustache file in template/pages will create a corresponding html file in /static/
• any required python package should be availlable via pip, and should be added to requirement.txt. see pip freeze to know what to write in the file.
• local debug mode is activated by creating a .debug file in the root directory, .debug is excluded in .gitignoreand .slugignore

This project is under BSD liscence. Some files are copyind from Twitter Bootstrap Project and so are under Apache Licence. See Licence-bootstrap.