Skip to content

Index

Alpha Release

Nbdev

This project is an attempt to port fastai Nbdev to Julia. Nbdev(both the oriignal version and the Julia version) are based on the idea of using Notebooks for literate programming.

On a very high level the base idea is this 👇

While both projects try to achieve the same base goal i.e. generating source code and documentation from Notebooks, the Julia version aims to start from Pluto notebook while the python version starts from a Jupyter notebook.

On the documentation side, I am using Mkdocs as the document generator while the original version uses Jekyll as the static site generator of choice.

Getting-started

Follow the tutorial to start experimenting with Nbdev.

First among the version

This is an alpha release of Nbdev so expect some breaks in plumbing here and there. Some features are still under development and are not included in this version.

  • Feel free to log any issues, bugs (which I expect to come) here

  • Anything that you feel like is missing and want to discuss the same or havean idea then start a new discussion here

What's more to come?

Well much more can be expected some of which are already thought of and some are not. However, the immediate requirements for future release are the following –>

  • Backlinks to source code.

  • Automatic document (markdown) generation using Github actions.

  • Testing for including plots/graphs from notebook to markdown document.