Site Layout

All files are placed relative to site-dir (root directory) with Markdown files in page-dir and images in image-dir. By default images are organized into folders for each notebook.

Given a Jupyter notebook notebook.ipynb, calling jekyllnb will result in the following site layout.

site-dir
├── page-dir
│   └── notebook.md
└── image-dir
    └── notebook <──── auto-generated
        ├── image1.png
        └── image2.png

Example

Calling jupyter jekyllnb --site-dir docs --page-dir _pages --image-dir assets/images hello-word.ipynb with the notebook located here will result in the following site layout.

docs
├── _pages
│   └── hello-world.md
└── assets
    └── images
        └── hello-world
            └── hello-world_4_0.png

Adding the --no-auto-folder flag will place all images in image-dir.

docs
├── _pages
│   └── hello-world.md
└── assets
    └── images
        └── hello-world_4_0.png