This repository contains Pluto's featured notebooks! Learn more about our featured notebook system here.
Right now, while we are still building up the system, the Pluto featured notebooks are invite-only: you should only submit a PR if you received an email from us. In a couple of months, we will change the system to also allow applications from the public. So if you are interested in contributing, hold on!
To add a notebook, simply add the file to this repository! It will be picked up automatically.
Important: fill out frontmatter, using Pluto's Frontmatter GUI. To open it, click the share button ( ), and then the frontmatter button in the top right. ( ). You need to fill in the following fields:
description
license
image
: should be a URLauthor_name
: usePluto.jl
if authored by Pluto devs, your name otherwiseauthor_url
: your github user page URLtags
: fill in as many tags as you wish! (lowercase, spaces allowed)
All notebook files in this repository will be rendered by PlutoSliderServer, but they will only show up in Pluto's main menu if they belong to a collection.
All current Pluto sample notebooks have had the Unlicense
license, which means that people can copy code snippets from sample notebooks and use them freely. If you also want to use the Unlicense
, great! If not, then also write a clear paragraph stating the license in the notebook itself.
The current featured system distributes notebook statefiles, which work the same way as Pluto's HTML export: people can read the notebook instantly, without having to wait for it to run. There is a button to Edit and Run a notebook that users can press to use the featured notebook as a template.
This means that sliders, buttons, etc don't immediately work, so notebooks that rely heavily on interactivity to tell a story are not a good fit. In the future, we plan to run a PlutoSliderServer for sample notebooks, allowing instant interaction like https://computationalthinking.mit.edu/, but until then, keep this in mind.
Check out these instructions to learn more about maintenance.