') .removeClass() .css('background', '#AAAAFF') .css('width', '100 %') .html('Notebook Output') ); container.show() """ display(Javascript(data=javascript)) def pandoc_html_render(markdown): """Render Pandoc Markdown->LaTeX content.""" # Convert the markdown directly to latex. This is what nbconvert does. latex = pandoc(markdown, "markdown", "latex") # Convert the pandoc generated latex to HTML so it can be rendered in # the web browser. html = pandoc(latex, "latex", "html", ["--mathjax"]) display(HTML(data="

HTML Pandoc Output

" \ "

" + html + "

")) return html def compare_render(markdown): notebook_render(markdown) pandoc_render(markdown) # # Outputs # In[1]: try: import lxml print 'LXML found!' except: print 'Warning! No LXML found - the old citation2latex filter will not work' # ## General markdown # Heading level 6 is not supported by Pandoc. # In[2]: compare_render(r""" # Heading 1 ## Heading 2 ### Heading 3 #### Heading 4 ##### Heading 5 ###### Heading 6""") # Headers aren't recognized by (Pandoc on Windows?) if there isn't a blank line above the headers. # In[3]: compare_render(r""" # Heading 1 ## Heading 2 ### Heading 3 #### Heading 4 ##### Heading 5 ###### Heading 6 """) print("\n"*10) # If internal links are defined, these will not work in nbviewer and latex as the local link is not existing. # In[4]: compare_render(r""" [Link2Heading](http://127.0.0.1:8888/0a2d8086-ee24-4e5b-a32b-f66b525836cb#General-markdown) """) # Basic Markdown bold and italic works. # In[5]: compare_render(r""" This is Markdown **bold** and *italic* text. """) # Nested lists work as well # In[6]: compare_render(r""" - li 1 - li 2 1. li 3 1. li 4 - li 5 """) # Unicode support # In[7]: compare_render(ur""" überschuß +***^°³³ α β θ """) # Pandoc may produce invalid latex, e.g \sout is not allowed in headings # In[8]: compare_render(r""" # Heading 1 ~~strikeout~~ """) # Horizontal lines work just fine # In[9]: compare_render(r""" above -------- below """) # ## Extended markdown of pandoc # (maybe we should deactivate this) # In[10]: compare_render(r""" This is Markdown ~subscript~ and ^superscript^ text. """) # No space before underline behaves inconsistent (Pandoc extension: intraword_underscores - deactivate?) # In[11]: compare_render(r""" This is Markdown not_italic_. """) # Pandoc allows to define tex macros which are respected for all output formats, the notebook not. # In[12]: compare_render(r""" \newcommand{\tuple}[1]{\langle #1 \rangle} $\tuple{a, b, c}$ """) # When placing the \newcommand inside a math environment it works within the notebook and nbviewer, but produces invalid latex (the newcommand is only valid in the same math environment). # In[13]: compare_render(r""" $\newcommand{\foo}[1]{...:: #1 ::...}$ $\foo{bar}$ """) # ## HTML or LaTeX injections # Raw HTML gets dropped entirely when converting to $\LaTeX$. # In[14]: compare_render(r""" This is HTML bold and italic text. """) # Same for something like center # In[15]: compare_render(r""" Center aligned """) # Raw $\LaTeX$ gets droppen entirely when converted to HTML. (I don't know why the HTML output is cropped here???) # In[16]: compare_render(r""" This is \LaTeX \bf{bold} and \emph{italic} text. """) # A combination of raw $\LaTeX$ and raw HTML # In[17]: compare_render(r""" **foo** $\left( \sum_{k=1}^n a_k b_k \right)^2 \leq$ b\$ar $$test$$ \cite{} """) # ## Tables # HTML tables render in the notebook, but not in Pandoc. # In[18]: compare_render(r"""

a	b
c	d

""") # Instead, Pandoc supports simple ascii tables. Unfortunately marked.js doesn't support this, and therefore it is not supported in the notebook. # In[19]: compare_render(r""" +---+---+ | a | b | +---+---+ | c | d | +---+---+ """) # An alternative to basic ascii tables is pipe tables. Pipe tables can be recognized by Pandoc and are supported by marked, hence, this is the **best way to add tables**. # In[20]: compare_render(r""" |Left |Center |Right| |:----|:-----:|----:| |Text1|Text2 |Text3| """) # Pandoc recognizes cell alignment in simple tables. Since marked.js doesn't recognize ascii tables, it can't render this table. # In[21]: compare_render(r""" Right Aligned Center Aligned Left Aligned ------------- -------------- ------------ Why does this actually work? Who knows ... """) print("\n"*5) # ## Images # Markdown images work on both. However, remote images are not allowed in $\LaTeX$. Maybe add a preprocessor to download these. # The alternate text is displayed in nbviewer next to the image. # In[22]: compare_render(r""" ![Alternate Text](http://ipython.org/_static/IPy_header.png) """) # HTML Images only work in the notebook. # In[23]: compare_render(r"""

""") # ## Math # Simple inline and displaystyle maths work fine # In[24]: compare_render(r""" My equation: $$ 5/x=2y $$ It is inline $ 5/x=2y $ here. """) # If the first \$ is on a new line, the equation is not captured by md2tex, if both \$s are on a new line md2html fails (Note the raw latex is dropped) but the notebook renders it correctly. # In[25]: compare_render(r""" $5 \cdot x=2$ $ 5 \cdot x=2$ $ 5 \cdot x=2 $ """) # MathJax permits some $\LaTeX$ math constructs without \$s, of course these raw $\LaTeX$ is stripped when converting to html. # Moreove, the & are escaped by the lxml parsing [#4251](https://github.com/ipython/ipython/issues/4251). # In[26]: compare_render(r""" \begin{align} a & b\\ d & c \end{align} \begin{eqnarray} a & b \\ c & d \end{eqnarray} """) # There is another lxml issue, [#4283](https://github.com/ipython/ipython/issues/4283) # In[27]: compare_render(r""" 1<2 is true, but 3>4 is false. $1<2$ is true, but $3>4$ is false. 1<2 it is even worse if it is alone in a line. """) # ## Listings, and Code blocks # In[28]: compare_render(r""" some source code ``` a = "test" print(a) ``` """) # Language specific syntax highlighting by Pandoc requires additional dependencies to render correctly. # In[29]: compare_render(r""" some source code ```python a = "test" print(a) ``` """)