support markdown output in nbconvert

IPython/nbconvert/exporters/html.py

@@ -1,66 +1,57 b''
 """HTML Exporter class"""
 
-#-----------------------------------------------------------------------------
-# Copyright (c) 2013, the IPython Development Team.
-#
+# Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
-#
-# The full license is in the file COPYING.txt, distributed with this software.
-#-----------------------------------------------------------------------------
-
-#-----------------------------------------------------------------------------
-# Imports
-#-----------------------------------------------------------------------------
 
 import os
 
 from IPython.nbconvert.filters.highlight import Highlight2HTML
 from IPython.config import Config
 
 from .templateexporter import TemplateExporter
 
 #-----------------------------------------------------------------------------
 # Classes
 #-----------------------------------------------------------------------------
 
 class HTMLExporter(TemplateExporter):
     """
     Exports a basic HTML document.  This exporter assists with the export of
     HTML.  Inherit from it if you are writing your own HTML template and need
     custom preprocessors/filters.  If you don't need custom preprocessors/
     filters, just change the 'template_file' config option.  
     """
     
     def _file_extension_default(self):
         return '.html'
 
     def _default_template_path_default(self):
         return os.path.join("..", "templates", "html")
 
     def _template_file_default(self):
         return 'full'
     
     output_mimetype = 'text/html'
     
     @property
     def default_config(self):
         c = Config({
             'NbConvertBase': {
-                'display_data_priority' : ['text/javascript', 'text/html', 'application/pdf', 'image/svg+xml', 'text/latex', 'image/png', 'image/jpeg', 'text/plain']
+                'display_data_priority' : ['text/javascript', 'text/html', 'text/markdown', 'application/pdf', 'image/svg+xml', 'text/latex', 'image/png', 'image/jpeg', 'text/plain']
                 },
             'CSSHTMLHeaderPreprocessor':{
                 'enabled':True
                 },
             'HighlightMagicsPreprocessor': {
                 'enabled':True
                 }
             })
         c.merge(super(HTMLExporter,self).default_config)
         return c
 
     def from_notebook_node(self, nb, resources=None, **kw):
         langinfo = nb.metadata.get('language_info', {})
         lexer = langinfo.get('pygments_lexer', langinfo.get('name', None))
         self.register_filter('highlight_code',
                              Highlight2HTML(pygments_lexer=lexer, parent=self))
         return super(HTMLExporter, self).from_notebook_node(nb, resources, **kw)

IPython/nbconvert/templates/html/basic.tpl

@@ -1,192 +1,198 b''
 {%- extends 'display_priority.tpl' -%}
 
 
 {% block codecell %}
 <div class="cell border-box-sizing code_cell rendered">
 {{ super() }}
 </div>
 {%- endblock codecell %}
 
 {% block input_group -%}
 <div class="input">
 {{ super() }}
 </div>
 {% endblock input_group %}
 
 {% block output_group %}
 <div class="output_wrapper">
 <div class="output">
 {{ super() }}
 </div>
 </div>
 {% endblock output_group %}
 
 {% block in_prompt -%}
 <div class="prompt input_prompt">
 {%- if cell.execution_count is defined -%}
 In&nbsp;[{{ cell.execution_count|replace(None, "&nbsp;") }}]:
 {%- else -%}
 In&nbsp;[&nbsp;]:
 {%- endif -%}
 </div>
 {%- endblock in_prompt %}
 
 {% block empty_in_prompt -%}
 <div class="prompt input_prompt">
 </div>
 {%- endblock empty_in_prompt %}
 
 {# 
   output_prompt doesn't do anything in HTML,
   because there is a prompt div in each output area (see output block)
 #}
 {% block output_prompt %}
 {% endblock output_prompt %}
 
 {% block input %}
 <div class="inner_cell">
     <div class="input_area">
 {{ cell.source | highlight_code(metadata=cell.metadata) }}
 </div>
 </div>
 {%- endblock input %}
 
 {% block output %}
 <div class="output_area">
 {%- if output.output_type == 'execute_result' -%}
     <div class="prompt output_prompt">
 {%- if cell.execution_count is defined -%}
     Out[{{ cell.execution_count|replace(None, "&nbsp;") }}]:
 {%- else -%}
     Out[&nbsp;]:
 {%- endif -%}
 {%- else -%}
     <div class="prompt">
 {%- endif -%}
     </div>
 {{ super() }}
 </div>
 {% endblock output %}
 
 {% block markdowncell scoped %}
 <div class="cell border-box-sizing text_cell rendered">
 {{ self.empty_in_prompt() }}
 <div class="inner_cell">
 <div class="text_cell_render border-box-sizing rendered_html">
 {{ cell.source  | markdown2html | strip_files_prefix }}
 </div>
 </div>
 </div>
 {%- endblock markdowncell %}
 
 {% block unknowncell scoped %}
 unknown type  {{ cell.type }}
 {% endblock unknowncell %}
 
 {% block execute_result -%}
 {%- set extra_class="output_execute_result" -%}
 {% block data_priority scoped %}
 {{ super() }}
 {% endblock %}
 {%- set extra_class="" -%}
 {%- endblock execute_result %}
 
 {% block stream_stdout -%}
 <div class="output_subarea output_stream output_stdout output_text">
 <pre>
 {{- output.text | ansi2html -}}
 </pre>
 </div>
 {%- endblock stream_stdout %}
 
 {% block stream_stderr -%}
 <div class="output_subarea output_stream output_stderr output_text">
 <pre>
 {{- output.text | ansi2html -}}
 </pre>
 </div>
 {%- endblock stream_stderr %}
 
 {% block data_svg scoped -%}
 <div class="output_svg output_subarea {{extra_class}}">
 {%- if output.svg_filename %}
 <img src="{{output.svg_filename | posix_path}}"
 {%- else %}
 {{ output.data['image/svg+xml'] }}
 {%- endif %}
 </div>
 {%- endblock data_svg %}
 
 {% block data_html scoped -%}
 <div class="output_html rendered_html output_subarea {{extra_class}}">
 {{ output.data['text/html'] }}
 </div>
 {%- endblock data_html %}
 
+{% block data_markdown scoped -%}
+<div class="output_markdown rendered_html output_subarea {{extra_class}}">
+{{ output.data['text/markdown'] | markdown2html }}
+</div>
+{%- endblock data_markdown %}
+
 {% block data_png scoped %}
 <div class="output_png output_subarea {{extra_class}}">
 {%- if 'image/png' in output.metadata.get('filenames', {}) %}
 <img src="{{output.metadata.filenames['image/png'] | posix_path}}"
 {%- else %}
 <img src="data:image/png;base64,{{ output.data['image/png'] }}"
 {%- endif %}
 {%- if 'width' in output.metadata.get('image/png', {}) %}
 width={{output.metadata['png']['width']}}
 {%- endif %}
 {%- if 'height' in output.metadata.get('image/png', {}) %}
 height={{output.metadata['png']['height']}}
 {%- endif %}
 >
 </div>
 {%- endblock data_png %}
 
 {% block data_jpg scoped %}
 <div class="output_jpeg output_subarea {{extra_class}}">
 {%- if 'image/jpeg' in output.metadata.get('filenames', {}) %}
 <img src="{{output.metadata.filenames['image/jpeg'] | posix_path}}"
 {%- else %}
 <img src="data:image/jpeg;base64,{{ output.data['image/jpeg'] }}"
 {%- endif %}
 {%- if 'width' in output.metadata.get('image/jpeg', {}) %}
 width={{output.metadata['image/jpeg']['width']}}
 {%- endif %}
 {%- if 'height' in output.metadata.get('image/jpeg', {}) %}
 height={{output.metadata['image/jpeg']['height']}}
 {%- endif %}
 >
 </div>
 {%- endblock data_jpg %}
 
 {% block data_latex scoped %}
 <div class="output_latex output_subarea {{extra_class}}">
 {{ output.data['text/latex'] }}
 </div>
 {%- endblock data_latex %}
 
 {% block error -%}
 <div class="output_subarea output_text output_error">
 <pre>
 {{- super() -}}
 </pre>
 </div>
 {%- endblock error %}
 
 {%- block traceback_line %}
 {{ line | ansi2html }}
 {%- endblock traceback_line %}
 
 {%- block data_text scoped %}
 <div class="output_text output_subarea {{extra_class}}">
 <pre>
 {{- output.data['text/plain'] | ansi2html -}}
 </pre>
 </div>
 {%- endblock -%}
 
 {%- block data_javascript scoped %}
 <div class="output_subarea output_javascript {{extra_class}}">
 <script type="text/javascript">
 {{ output.data['text/javascript'] }}
 </script>
 </div>
 {%- endblock -%}

IPython/nbconvert/templates/latex/skeleton/display_priority.tplx

@@ -1,41 +1,44 b''
 ((= Auto-generated template file, DO NOT edit directly!
     To edit this file, please refer to ../../skeleton/README.md =))
 
 
 ((*- extends 'null.tplx' -*))
 
 ((=display data priority=))
 
 
 ((*- block data_priority scoped -*))
     ((*- for type in output.data | filter_data_type -*))
         ((*- if type == 'application/pdf' -*))
             ((*- block data_pdf -*))
             ((*- endblock -*))
         ((*- elif type == 'image/svg+xml' -*))
             ((*- block data_svg -*))
             ((*- endblock -*))
         ((*- elif type == 'image/png' -*))
             ((*- block data_png -*))
             ((*- endblock -*))
         ((*- elif type == 'text/html' -*))
             ((*- block data_html -*))
             ((*- endblock -*))
+        ((*- elif type == 'text/markdown' -*))
+            ((*- block data_markdown -*))
+            ((*- endblock -*))
         ((*- elif type == 'image/jpeg' -*))
             ((*- block data_jpg -*))
             ((*- endblock -*))
         ((*- elif type == 'text/plain' -*))
             ((*- block data_text -*))
             ((*- endblock -*))
         ((*- elif type == 'text/latex' -*))
             ((*- block data_latex -*))
             ((*- endblock -*))
         ((*- elif type == 'application/javascript' -*))
             ((*- block data_javascript -*))
             ((*- endblock -*))
         ((*- else -*))
             ((*- block data_other -*))
             ((*- endblock -*))
         ((*- endif -*))
     ((*- endfor -*))
 ((*- endblock data_priority -*))

IPython/nbconvert/templates/markdown.tpl

@@ -1,63 +1,67 b''
 {% extends 'display_priority.tpl' %}
 
 
 {% block in_prompt %}
 {% endblock in_prompt %}
 
 {% block output_prompt %}
 {%- endblock output_prompt %}
 
 {% block input %}
 {{ cell.source | indent(4)}}
 {% endblock input %}
 
 {% block error %}
 {{ super() }}
 {% endblock error %}
 
 {% block traceback_line %}
 {{ line | indent | strip_ansi }}
 {% endblock traceback_line %}
 
 {% block execute_result %}
 
 {% block data_priority scoped %}
 {{ super() }}
 {% endblock %}
 {% endblock execute_result %}
 
 {% block stream %}
 {{ output.text | indent }}
 {% endblock stream %}
 
 {% block data_svg %}
 ![svg]({{ output.svg_filename | path2url }})
 {% endblock data_svg %}
 
 {% block data_png %}
 ![png]({{ output.metadata.filenames['image/png'] | path2url }})
 {% endblock data_png %}
 
 {% block data_jpg %}
 ![jpeg]({{ output.metadata.filenames['image/jpeg'] | path2url }})
 {% endblock data_jpg %}
 
 {% block data_latex %}
 {{ output.data['text/latex'] }}
 {% endblock data_latex %}
 
 {% block data_html scoped %}
 {{ output.data['text/html'] }}
 {% endblock data_html %}
 
+{% block data_markdown scoped %}
+{{ output.data['text/markdown'] }}
+{% endblock data_markdown %}
+
 {% block data_text scoped %}
 {{ output.data['text/plain'] | indent }}
 {% endblock data_text %}
 
 {% block markdowncell scoped %}
 {{ cell.source }}
 {% endblock markdowncell %}
 
 {% block unknowncell scoped %}
 unknown type  {{ cell.type }}
 {% endblock unknowncell %}
  No newline at end of file

IPython/nbconvert/templates/skeleton/display_priority.tpl

@@ -1,37 +1,40 b''
 {%- extends 'null.tpl' -%}
 
 {#display data priority#}
 
 
 {%- block data_priority scoped -%}
     {%- for type in output.data | filter_data_type -%}
         {%- if type == 'application/pdf' -%}
             {%- block data_pdf -%}
             {%- endblock -%}
         {%- elif type == 'image/svg+xml' -%}
             {%- block data_svg -%}
             {%- endblock -%}
         {%- elif type == 'image/png' -%}
             {%- block data_png -%}
             {%- endblock -%}
         {%- elif type == 'text/html' -%}
             {%- block data_html -%}
             {%- endblock -%}
+        {%- elif type == 'text/markdown' -%}
+            {%- block data_markdown -%}
+            {%- endblock -%}
         {%- elif type == 'image/jpeg' -%}
             {%- block data_jpg -%}
             {%- endblock -%}
         {%- elif type == 'text/plain' -%}
             {%- block data_text -%}
             {%- endblock -%}
         {%- elif type == 'text/latex' -%}
             {%- block data_latex -%}
             {%- endblock -%}
         {%- elif type == 'application/javascript' -%}
             {%- block data_javascript -%}
             {%- endblock -%}
         {%- else -%}
             {%- block data_other -%}
             {%- endblock -%}
         {%- endif -%}
     {%- endfor -%}
 {%- endblock data_priority -%}