question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Support for Markdown in Jupyter Notebook outputs

See original GitHub issue

The older version of Jupyter Book supported Markdown in Jupyter Notebook outputs, but it seems like the newer version of Jupyter Book no longer does. It would be great to add back support for Markdown in cell outputs.

For example, running code like this would generate Markdown that would be displayed in a published Jupyter Book:

from IPython.display import Markdown, display

def display_bolded_topic_words_in_context(topic_number=3):
    
    display(Markdown(original_text))
    
    return 

Example of older version of Jupyter Book rendering Markdown output

Screen Shot 2020-07-06 at 4 24 50 PM

Example of older version of Jupyter Book rendering Markdown output

Screen Shot 2020-07-06 at 4 24 57 PM

Example of newer version of Jupyter Book not rendering Markdown output

Screen Shot 2020-07-06 at 4 25 06 PM

Example of newer version of Jupyter Book not rendering Markdown output

Screen Shot 2020-07-06 at 4 25 12 PM

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:1
  • Comments:6 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
chrisjsewellcommented, Sep 1, 2020

This should be closed in v0.8.0 😄, but feel free to re-open/open another issue if anything is outstanding: https://jupyterbook.org/reference/_changelog.html#v0-8-0-2020-09-01

1reaction
chrisjsewellcommented, Jul 6, 2020

Actually, there’s a distinct difference between executablebooks/MyST-NB#198 and what it appears was offered by the old jupyter book:

  • the former is attempting to inject the output markdown into the surrounding documentation, so it would not have its own output box and e.g. footnotes would appear at the bottom of the document
  • the latter treats the output markdown as an isolated piece of text, e.g. footnotes would appear at the bottom of this text, and wraps it in an output box

These are two distinct use cases, and we should consider if/how we support one or both.

Read more comments on GitHub >

github_iconTop Results From Across the Web

python - How to programmatically generate markdown output ...
I want to write a report for classes in Jupyter notebook. I'd like to count some stuff, generate ...
Read more >
Formatting code outputs - Jupyter Book
Formatting code outputs#. The formatting of code outputs is highly configurable. Below we give examples of how to format particular outputs and even...
Read more >
Markdown Cells — Jupyter Notebook 6.5.2 documentation
Markdown Cells . Text can be added to Jupyter Notebooks using Markdown cells. You can change the cell type to Markdown by...
Read more >
The Ultimate Markdown Guide (for Jupyter Notebook) - Medium
It is simple to use and helps you to create and share documents that include code, visualizations, and narration. Recall that a Jupyter...
Read more >
Markdown for Jupyter notebooks cheatsheet - IBM
You can use Markdown to format documentation you add to Markdown cells in your Jupyter notebook.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found