jupyter-book icon indicating copy to clipboard operation
jupyter-book copied to clipboard

Interface for non-Jupyter notebooks

Open cadojo opened this issue 3 years ago • 2 comments

Context

Pluto.jl has a huge following in the Julia community. It would be really cool if there was a standard "executable books" interface for non-Jupyter notebooks.

Proposal

I'm proposing a documented interface which jupyter-book follows so non-Jupyter notebooks could be built.

I spend a lot of time within the Julia community, so my knowledge and background are a bit biased towards Julia, but I know that Julia folks are working on standardized educational content. For example, a lot of work has been done to add HTML metadata to Pluto notebooks so that metadata can be parsed on websites.

I know non-Jupyter notebooks might seem like a silly proposal for the jupyter-book repository, but I absolutely love the vision behind "executable books". I've seen the kind of great work it enables, such as the in-progress Mathematics of Machine Learning textbook.

Tasks and updates

  • [ ] Discuss. Is this a good idea? Is this kind of work part of the Executable Books organizational vision?
  • [ ] Define what work would need to be completed for an interface to be defined.
  • [ ] Much, much more!

cadojo avatar Jun 24 '22 03:06 cadojo

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.
If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).
Welcome to the EBP community! :tada:

welcome[bot] avatar Jun 24 '22 03:06 welcome[bot]

Hi @cadojo - I wanted to quickly point you to one thing that may be able to accomplish what you're trying to do already:

Custom notebook formats

A while ago, there was a similar request about RMarkdown files in this issue and a reasonably workable solution was introduced into Jupyterbook by the admins.

I think one way to go about this is to add functionality to the jupytext project for Pluto.jl notebooks, and then it should just work with the executable books.

For anything more first-party, will have to wait for one of the core maintainers comment. This looks super interesting though!

firasm avatar Jul 04 '22 20:07 firasm