Skip to content

ryansb/bookmarkd

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

(note)book markd(own)

Write markdown, use notebooks

With bookmarkd you can use any text editor you like to write markdown with Python code blocks and render them as an IPython notebook.

This README can be converted to a notebook using the command bookmarkd convert README.md README.ipynb

Usage

## markdown -> notebook
$ bookmarkd convert foo.md foo.ipynb
## notebook -> markdown
$ bookmarkd convert foo.ipynb foo.md
## notebook -> markdown using nbconvert
$ ipython nbconvert --to markdown foo.ipynb

# receive markdown via stdin
$ bookmarkd convert - foo.ipynb
# output notebook on stdout
$ bookmarkd convert foo.md -

Code blocks are converted to IPython notebook cells, and each markdown section between code blocks is made into a markdown cell in the notebook. To manually separate markdown into cells, separate blocks with horizontal rules (---).

The --no-join-blocks option will force each markdown block to become its own cell in the notebook.


Let's see some Python now!

print "Hello World"

This is how blocks separated by --- are rendered


They become separate markdown cells instead of being merged together.

Now let's see some more Python.

print "Hello" + " " + "World"

Contributing

Please see the Code of Conduct for contributors. Pull requests are welcome, but please include some docs for your change. You can do this either in the README or in bookmarkd --help.


License

Bookmarkd is made available under the GNU Affero General Public License, see LICENSE.txt for details.

About

Markdown -> IPython conversion tool

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages