⚡️ Turn Jupyter Notebooks into Blog Posts
📔

⚡️ Turn Jupyter Notebooks into Blog Posts

7月 15, 2024·
徐鹏
徐鹏
· 3 分钟阅读时长
Image credit: HugoBlox
blog

As a researcher or data scientist, your work often lives in Jupyter Notebooks. But sharing those insights effectively usually means taking screenshots, messy copy-pasting, or exporting to PDF.

Hugo Blox changes that. With the {{< notebook >}} shortcode, you can render your actual .ipynb files directly as beautiful, interactive blog posts or project pages. Keep your code, outputs, and narrative in one place.

目录

Why publish notebooks?

提示

Reproducible Research: By publishing the actual notebook, you allow others to download and run your code, verifying your results and building upon your work.

  • No more screenshots – Render crisp code and vector plots directly from your source.
  • Theme consistent – Notebooks automatically adapt to your site’s theme (including dark mode).
  • Flexible sourcing – Display notebooks from your assets/ folder, page bundles, or even directly from a remote GitHub URL.
  • Interactive – Users can copy code blocks or download the full notebook to run locally.

Example: Data Science Workflow

Below is a live example of a notebook rendered right here in this post. Notice how the markdown, code, and outputs (text, HTML, and JSON) are all preserved and styled.

Launch Readiness Analysis

Python · Kernel: Python 3 · nbformat 4.5 · 6 cells

Download notebook
Markdown

Ship Notebook Stories in Minutes

Hugo Blox Notebook renderer turns your .ipynb experiments into beautiful long-form posts. Use this sample to see how markdown, code, and outputs flow together.

Markdown
  1. Drop notebooks inside assets/notebooks/ (or import them as page resources).
  2. Reference them with {{</* notebook src="your.ipynb" */>}}.
  3. Control code, outputs, metadata badges, and download links via shortcode params.
In [1]
demo quickstart
1
2
3
4
5
6
import math
accuracy = 0.982
print("Collecting data...")
print("Training notebook-ready block...")
print("Done!")
accuracy
Collecting data...
Training notebook-ready block...
Done!
0.982
In [2]
1
2
from IPython.display import HTML
HTML("<div style='font-family:Inter,ui-sans-serif;'><strong>Launch Readiness:</strong> <span style='color:#22c55e;'>98.2% confidence</span><br><em>Notebook blocks are theme-aware and dark-mode friendly.</em></div>")
Launch Readiness: 98.2% confidence
Notebook blocks are theme-aware and dark-mode friendly.
In [3]
metrics
1
2
3
4
5
6
7
8
metrics = {
    'metrics': {
        'engagement_rate': 0.73,
        'read_time_minutes': 4.6,
        'subscribers': 1280
    }
}
metrics
{
  "metrics": {
    "engagement_rate": 0.73,
    "read_time_minutes": 4.6,
    "subscribers": 1280
  }
}
Markdown

Tip: Pair this block with Call-to-Action cards or the Embed shortcode to link to GitHub repos, datasets, or ARXIV preprints.

Powered by Hugo Blox Kit - https://github.com/HugoBlox/kit

How to add a notebook

  1. Save your notebook. Place your .ipynb file in assets/notebooks/ (for global access) or inside a page bundle (like content/blog/my-post/analysis.ipynb).
  2. Add the shortcode. In any Markdown page, simply use: {{< notebook src="analysis.ipynb" >}}
  3. Customize. You can hide code cells for non-technical audiences (show_code=false) or just show the output (show_outputs=true).
重要

Hugo Blox respects your privacy. Notebook rendering happens statically at build time—no third-party services required.

Next steps

  • Try it out: Drop one of your existing notebooks into this site and see how it looks.
  • Link your papers: Use the Embed shortcode to link your notebook to your latest arXiv preprint or GitHub repository.
  • Get help: Join the community on Discord or check the documentation.

Happy researching! 🚀

徐鹏
Authors
伊犁师范大学教师
从事植物基因组学与生物信息学研究的高校老师,主要关注多组学数据分析、基因组进化与全基因组复制事件解析, 以及面向复杂植物基因组的计算方法开发。研究致力于将大规模计算模型与进化基因组学相结合,推动植物功能基因组学与系统发育研究的发展。 当前工作聚焦于构建高精度基因组资源与可复用的分析框架,以服务植物遗传改良与生物多样性研究。