nbsanity - Share Notebooks as Polished Web Pages in Seconds

2024-12-13 · Source: Hamel Husain's Blog · Field: Technology & Digital — Software Development & Engineering, Data Science & Analytics, Artificial Intelligence & Machine Learning · Depth: Intermediate, medium

Summary

nbsanity, a new free service launched on December 13, 2024, transforms public Jupyter notebooks from GitHub or Gists into polished, readable web pages instantly. Developed by Hamel Husain, this tool addresses limitations of GitHub's native notebook viewer, such as sluggish rendering, lack of code cell collapsing, and limited customization. nbsanity is powered by Quarto, an open-source publishing system, which enables advanced features like cell visibility control, output management, error handling, and content organization through simple `#|` directives. The service provides quality-of-life improvements including a table of contents, a link to the original GitHub URL, and text wrapping in code cells, along with social cards for better sharing. It operates as a rendering-only service, ensuring security and offering a caching system that preserves historical notebook renders.

Key takeaway

For AI Engineers and technical writers sharing Jupyter notebooks, nbsanity simplifies the process of presenting work professionally. You can instantly transform any public GitHub notebook into a polished, customizable web page without setup, enhancing readability and collaboration. Consider integrating nbsanity into your workflow for sharing tutorials, "Today I Learned" posts, or project documentation to improve presentation quality and accessibility.

Key insights

nbsanity offers instant, polished web rendering for public GitHub Jupyter notebooks using Quarto directives.

Principles

• Reduce friction in knowledge sharing.
• Prioritize simplicity and zero setup.
• Leverage open-source publishing systems.

Method

Replace "github.com" with "nbsanity.com" in a public GitHub notebook URL, or use a provided bookmarklet, to render the notebook as a polished web page via Quarto.

In practice

• Use `#|include: false` to hide code cells.
• Apply `{.panel-tabset}` for tabbed content.
• Utilize `#|code-fold: true` for collapsible code.

Topics

• Jupyter Notebooks
• Web Publishing
• Quarto
• GitHub Integration
• Technical Communication

Code references

• fastai/lm-hackers
• hamelsmu/nbsanity

Best for: AI Engineer, Machine Learning Engineer, NLP Engineer, Software Engineer, Data Scientist, Research Scientist

Related on AIssential

• Introducing fastpages, An easy to use blogging platform with extra features for Jupyter Notebooks. — fastpages offers automated, feature-rich blogging from Jupyter Notebooks, Word, or Markdown via GitHub Pages and Actions.
• Nbdev: A literate programming environment that democratizes software engineering best practices — nbdev integrates software engineering best practices directly into Jupyter notebooks, simplifying development workflows.
• Try notebooks in Gemini to easily keep track of projects — Gemini notebooks offer a synced knowledge base across Gemini and NotebookLM for project organization.
• The Notebook That Science Built Its Future On Is Broken. Here’s the Proof — and the Fix. — Jupyter notebooks, despite widespread use, pose a severe reproducibility challenge for published scientific research.
• Reinventing the Python Notebook with Akshay Agrawal — Marimo reinvents Python notebooks with a reactive execution model, enabling reproducible, version-controlled, and interactive data exploration and application development.
• The VS Code Blueprint: How Non-Coder Professionals Build the AI System You Dreamed Of — VS Code offers non-coders a unified AI productivity workspace to overcome tool fragmentation.

Open in AIssential →

Editorial summary, takeaway, and curation by AIssential. Original article published by Hamel Husain's Blog.