Skip to main content

Convert markdown to IPython notebook.

Project description

[notedown] is a simple tool to create [IPython notebooks][ipython] from markdown.

[ipython]: [notedown]:


notedown > output.ipynb


pip install notedown

It is really simple and separates your markdown into code and not code. Code goes into code cells, not-code goes into markdown cells.

Fenced code blocks annotated with a language other than python are read into cells using IPython’s %% [cell magic][].

[cell magic]:

### Why?

I don’t know. Maybe you prefer writing in markdown.

### What notedown does not do:

  • run code cells

  • embed figures

### Conversion from notebook to markdown

Converting from an IPython notebook to markdown is done using nbconvert:

ipython nbconvert notebook.ipynb –to markdown

The IPython markdown export is currently quite basic, so you can’t expect to convert markdown -> notebook -> markdown and get back your original markdown.

### Running an IPython Notebook

You can open the notebook in your browser with

ipython notebook your_notebook.ipynb

and use Cell -> Run all in the menu.

You can run notebooks non-interactively from the command line using [runipy][]:

pip install runipy runipy your_notebook.ipynb

### TODO

  • [x] support more markdowns

  • [ ] allow other cell types?

  • [x] allow different language code cells (using %%lang magic)

  • [ ] allow code attributes? pass to cell creator?

  • [x] code block format agnostic (fenced / indented)

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

notedown-1.0.3.tar.gz (5.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page