Add custom nbconvert template to add captions to images

Solves #6
Based on jupyter/nbconvert#1112 but applied
to markdown rather than HTML

build/build_pages.py

@@ -21,7 +21,7 @@
         process = subprocess.Popen([
             'jupyter', 'nbconvert',
             notebook_path,
-            '--to', 'markdown',
+            '--to', 'markdown', '--template=build/markdown_with_captions.tpl',
             '--TagRemovePreprocessor.enabled=True',
             "--TagRemovePreprocessor.remove_cell_tags=['remove_cell']",
             "--TagRemovePreprocessor.remove_input_tags=['remove_input']",
@@ -33,6 +33,7 @@
             'jupyter nbconvert',
             notebook_path,
             '--to markdown',
+            '--template=build/markdown_with_captions.tpl',
             '--TagRemovePreprocessor.enabled=True',
             "--TagRemovePreprocessor.remove_cell_tags=\"['remove_cell']\"",
             "--TagRemovePreprocessor.remove_input_tags=\"['remove_input']\"",
@@ -53,7 +54,7 @@
     file_data = re.sub(f'{post}_files/', f'/images/{post}/', file_data)
 
     # remove captions
-    file_data = re.sub(r'!\[\w+\]', '![]', file_data)
+    # file_data = re.sub(r'!\[\w+\]', '![]', file_data)
 
     # remove additional table formatting
     file_data = re.sub('table border="1" class="dataframe"', 'table', file_data)

build/markdown_with_captions.tpl

@@ -0,0 +1,74 @@
+{% extends 'display_priority.tpl' %}
+
+
+{% block in_prompt %}
+{% endblock in_prompt %}
+
+{% block output_prompt %}
+{%- endblock output_prompt %}
+
+{% block input %}
+```
+{%- if 'magics_language' in cell.metadata  -%}
+    {{ cell.metadata.magics_language}}
+{%- elif 'name' in nb.metadata.get('language_info', {}) -%}
+    {{ nb.metadata.language_info.name }}
+{%- endif %}
+{{ cell.source}}
+```
+{% 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 %}
+![{{(output | get_metadata('alt', 'image/svg+xml')) or (cell | get_metadata('alt')) or ""}}]({{ output.metadata.filenames['image/svg+xml'] | path2url }})
+{% endblock data_svg %}
+
+{% block data_png %}
+![{{(output | get_metadata('alt', 'image/png')) or (cell | get_metadata('alt')) or ""}}]({{ output.metadata.filenames['image/png'] | path2url }})
+{% endblock data_png %}
+
+{% block data_jpg %}
+![{{(output | get_metadata('alt', 'image/jpeg')) or (cell | get_metadata('alt')) or ""}}]({{ 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 %}