How jupyter/nbconvert-examples works
Project type and purpose
• This repository is an “examples” project for Jupyter nbconvert. It’s not a deployed service or full-stack app, but a catalog of usage scenarios showing how to extend and customize the nbconvert pipeline (filters, preprocessors, templates, output formats, Sphinx integration, etc.).
• The README simply says “Examples that illustrate how nbconvert can be used,” confirming its role as sample code rather than a single monolithic application.
File structure
• Top-level elements:
• basic/
• citations/
• custom_filter/
• custom_latex_cell_style/
• custom_preprocessor/
• custom_template/
• hr_cell_style/
• images/
• latex_cell_style/
• notebook_cell_style/
• pdf/
• sphinx_class/
• Each directory encapsulates one scenario: it contains an ipython_nbconvert_config.py (to register custom code), one or more .tpl/.tplx templates or .py filter/preprocessor classes, and a test notebook.
• There are no “backend” or “frontend” sub-projects, but rather multiple plugin-style components that hook into the single nbconvert engine.
README for additional insights
• The README is minimal and does not spell out architecture; it simply labels the repo as “nbconvert-examples.” The detailed insight comes from the directory names and their contents.
Elements
• Clear labels for each pipeline stage and extension type.
• Orange for external tools (LaTeX, Sphinx)
• Purple for final outputs (HTML, PDF, etc.)
Putting it all together
• Beneath or alongside, group example folders to show that each scenario demonstrates one or more extension points.