Git Product home page Git Product logo

allencellmodeling.github.io's Introduction

To add and display a new notebook as a page on the site:

Things that you do to the notebook

  • Make sure you have the figures sized as you want them to appear
  • Add 'raw nbconvert' cell at the start of the notebook declaring the layout as post and the title of the post. This YAML front matter will be used to render the notebook's information on the index page, e.g.
---
title: Publishing a Jupyter-notebook
summary: A short explanation to appear on the index page. 
---
  • Title the .ipynb file in the format YEAR-MONTH-DAY-title so that it becomes, e.g., 2017-08-17-test_notebook.ipynb
  • Set the $NOTEBOOKNAME bash variable as in NOTEBOOKNAME=2017-08-17-test_notebook.ipynb

Things you do to the repo

  • Pull from master
  • Put the .ipynb file in the _posts directory
  • Convert the notebook to a markdown file using
jupyter nbconvert --to markdown --NbConvertApp.output_files_dir='../assets/nbfiles/{notebook_name}' --FilesWriter.relpath='({{ site.url }}/assets/nbfiles/' $NOTEBOOKNAME
  • This creates a markdown file like 2017-07-17-test_notebook.md and the related images in ../assets/nbfiles/2017-07-17-test_notebook_files
  • Move the .ipynb to ../assets/notebooks

The conversion and moving processes are scriptable for future improvement.

allencellmodeling.github.io's People

Contributors

cdw avatar donovanr avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.