Include *.ipynb files and not only *.md files

[francoisschwarzentruber]

Problem

I want to be able to include *.ipynb files (Jupyter notebook files) in my book. The problem is that mdbook does not recognize these files. We could circonvent this problem by first convert the *.ipynb files into *.md but this is tedious.

Proposed Solution

Being able to include *.ipynb files for free!

Notes

No response

[Amane-Fujimiya]

This is one year old, but I seriously concur the development. Might have a plugin for it?

[joaoprocopio]

https://github.com/rojesh-shikhrakar/mdbook-jupyter

@rojesh-shikhrakar is working on this cool project!
the implementation is pretty simple, and it works properly, this could be included inside the main repo, or as a extension:

• like katex: https://github.com/lzanini/mdbook-katex
• or mermaid: https://github.com/badboy/mdbook-mermaid

[Amane-Fujimiya]

https://github.com/rojesh-shikhrakar/mdbook-jupyter

@rojesh-shikhrakar is working on this cool project! the implementation is pretty simple, and it works properly, this could be included inside the main repo, or as a extension:

• like katex: https://github.com/lzanini/mdbook-katex
• or mermaid: https://github.com/badboy/mdbook-mermaid

If I may ask, is the preprocessor stable in performance?

[joaoprocopio]

@Amane-Fujimiya, i have only used it in a small project that i have: https://github.com/joaoprocopio/pydsa.

in my case, it was the fastest alternative regarding build time.
all builds run in less than a second. but i may not be the best reference since the book that i'm building is tiny.

i've used jupyter book, and it was an awful experience: https://jupyterbook.org/stable/
mdbook with mdbook-jupyter was a breath of fresh air.

if you check the source code for mdbook-jupyter it's simple; it just parses the notebook json file, loads it in memory, do some string processing when it's needed, and then converts it to markdown.

https://github.com/rojesh-shikhrakar/mdbook-jupyter/blob/master/src/converter.rs

overall, i really think that you should try it yourself; it's pretty good.

the only caveat that i've found is that you need to use mdbook in the same version as the preprocessor, more details on this issue: rojesh-shikhrakar/mdbook-jupyter#4.

https://github.com/rojesh-shikhrakar/mdbook-jupyter/blob/master/Cargo.toml#L22

you'll need to bump down your mdbook version for v0.5 which the latest currently to v0.4.