Skip to main content

A simple notebook HTML renderer

Project description

nbh

⚡️ Create a beautiful notebook HTML file from a Jupyter notebook

Highlights

very opinionated HTML renderer for Jupyter notebooks, focusing on simplicity and readability.

It supports Markdown, LaTeX, and Python code cells, with a clean and minimal design.

Tufte CSS is used for styling, providing a clean and elegant look, Github Flavored Markdown is used for rendering Markdown cells, and KaTeX is used for rendering LaTeX equations.

Sample Output

See intro_to_latex.ipynb and the generated intro_to_latex.html for a more complex example.

Usage

The recommended way is to use uvx:

# outputs my_notebook.html in the same directory
uvx nbh my_notebook.ipynb
# outputs each ipynb in the /tmp directory
uvx nbh *.ipynb --output /tmp

If you want the latest version, you can run it directly from the GitHub repository (unstable):

# outputs my_notebook.html in the same directory
uvx git+https://github.com/Mistobaan/nbh my_notebook.ipynb
# outputs my_notebook.html in the /tmp directory
uvx git+https://github.com/Mistobaan/nbh my_notebook.ipynb --output /tmp

License

nbh is licensed under the MIT LICENSE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nbh-0.1.4.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nbh-0.1.4-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

Details for the file nbh-0.1.4.tar.gz.

File metadata

  • Download URL: nbh-0.1.4.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.7

File hashes

Hashes for nbh-0.1.4.tar.gz
Algorithm Hash digest
SHA256 7ee1bc719951aa82d3e2cb9c7a1bbffeb9b41fe2c637759d2a45384d05e6b636
MD5 e89445bf45c5919f7a72bcb19dbc2f0d
BLAKE2b-256 2cb79cc9fbdfbdf3192bd5c84ade9e631375175d3a9b7edcd250ad0d5339d4a0

See more details on using hashes here.

File details

Details for the file nbh-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: nbh-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 12.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.7

File hashes

Hashes for nbh-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 0aae6e3fd489549349da384c001df7e8fa196242b6da4792e0dcc7dfd63c72f5
MD5 4c3ed28ae7d9bb362de316f161879ba3
BLAKE2b-256 90828eebab62e2651eb23603cc9e55b8329800a30dd691b4197216f64cfa6a6a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page