README.md

🔭 Jupyscope

A Jupyter notebook viewer implemented in C#. It converts ipynb files to html.

Get started

A use case is provided in the Jupyscope.Client project:

// Some ipynb file content
var notebookJsonString = ...; 

// Deserialize the notebook content
var notebook = TelescopeConverter.Deserialize<Notebook>(notebookJsonString);

// HTML ready to display notebook
var htmlNotebook = $"{HTMLHeaderHelper.Header}{notebook.ToHtml()}{HTMLHeaderHelper.Footer}";

Dev resources

• ipynb file format reference

External dependencies

• Markdig
• Katex
• Highlight.js

Known limitations

• Only svg, png, and html cell outputs are supported.
• Math support is partial (\begin{align}...\end{align}, ...)
• Output attachments not supported
• Markdown local filesystem references not supported