Notebook extension structure¶
The nbextensions are stored in the repository each as a separate subdirectory of
Each notebook extension typically has its own directory named after the extension, containing:
thisextension/thisextension.yml- file describing the nbextension to the
thisextension/README.md- readme file describing the nbextension in markdown format
The file names do not need to have the shown names, they can be chosen freely, as long as they refer to each other using the appropriate names.
This is an example for the main
And for the
Type: Jupyter Notebook Extension Compatibility: 4.x, 5.x Name: This Extension Main: thisextension.js Icon: icon.png Link: README.md Description: My super duper extension Parameters: - name: thisextension.my_config_value description: Number of dupers to create input_type: number min: -1 step: 1 default: 100
For further details on the yaml file format, and the option types supported by the configurator, see the jupyter_nbextension_configurator repo.
When supplying a
README.md file, please supply a main heading with the
nbextension’s title, as this will be linked in the generated documentation at
This is a simple example for a
This extension ============== A quick summary of what this nbextension does. Usage ----- A more detailed description can go here, maybe covering different variations of functionality, differences in versions or for different kernels etc. ![Screenshot image](screenshot.png) Options ------- Some description of the different options the nbextension provides, what they do, and their default values Internals --------- How this extension works.