This page was generated from doc/index.jupyter. Interactive online version: .

An Experimental New Storage Format For Jupyter Notebooks

Source code repository and issue tracker: https://github.com/mgeier/jupyter-format/

Dedicated to the public domain using CC0 – see the file LICENSE for details.

Note

All source files for this documentation are Jupyter notebooks stored in the proposed new storage format.

WARNING

This is in an experimental state. Neither the format nor the implementation is stable and either can change at any time without prior notice.

• Installation
  • JupyterLab and Classic Notebook Integration
  • Usage on Binder
• Motivation
  • Status Quo
  • YAML as Almost-Solution
  • Other Partial Solutions
  • The Need for a Custom Format
  • Complementary Tools
• Specification
• Conversion
• API Documentation
  • generate_lines()
  • serialize()
  • deserialize()
  • ParseError
  • Contents Manager
  • Exporters for nbconvert
    • JupyterImportMixin
      • JupyterImportMixin.from_file()
      • JupyterImportMixin.from_filename()
    • JupyterExporter
      • JupyterExporter.from_notebook_node()
    • ASCIIDocExporter
    • HTMLExporter
    • LatexExporter
    • MarkdownExporter
    • NotebookExporter
    • PDFExporter
    • PythonExporter
    • RSTExporter
    • ScriptExporter
    • SlidesExporter
    • TemplateExporter
  • Batch Conversion with replace_all
    • ipynb_to_jupyter()
    • replace_all_recursive()