]> git.madduck.net Git - etc/mutt.git/blobdiff - .mutt/markdown2html

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

projects / etc / mutt.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Render self-contained HTML with Pandoc
[etc/mutt.git] / .mutt / markdown2html
diff --git a/.mutt/markdown2html b/.mutt/markdown2html
index 44ec07c99cab6ae0fcd109dcac6375a853e93bcc..2ffe54faeb64a8fffffc2dd78dc72c6af025af71 100755 (executable)
--- a/.mutt/markdown2html
+++ b/.mutt/markdown2html
@@ -48,20 +48,24 @@ except ImportError:
 
 
 DEFAULT_CSS += '''
 
 
 DEFAULT_CSS += '''
-.quote {
+.block {
+    padding: 0 0.5em;
+    margin: 0;
+    border-left: 2px solid #eee;
+}
+.quote, blockquote {
     padding: 0 0.5em;
     margin: 0;
     font-style: italic;
     padding: 0 0.5em;
     margin: 0;
     font-style: italic;
-    border-left: 2px solid #ccc;
-    color: #999;
+    border-left: 2px solid #666;
+    color: #666;
     font-size: 80%;
 }
 .quotelead {
     font-size: 80%;
 }
 .quotelead {
-    font-style: italic;
     margin-bottom: -1em;
     margin-bottom: -1em;
-    color: #999;
     font-size: 80%;
 }
     font-size: 80%;
 }
+.quotechar { display: none; }
 .footnote-ref, .footnote-back { text-decoration: none;}
 .signature {
     color: #999;
 .footnote-ref, .footnote-back { text-decoration: none;}
 .signature {
     color: #999;
@@ -69,28 +73,45 @@ DEFAULT_CSS += '''
     white-space: pre;
     margin: 1em 0 0 0;
     font-size: 80%;
     white-space: pre;
     margin: 1em 0 0 0;
     font-size: 80%;
-}'''
+}
+table, th, td {
+    border-collapse: collapse;
+    border: 1px solid #999;
+}
+th, td { padding: 0.5em; }
+.header {
+    background: #eee;
+}
+.even { background: #eee; }
+h1, h2, h3, h4, h5, h6 {
+    color: #666;
+    background-color: #eee;
+    padding-left: 0.5em
+}
+h1 { font-size: 130%; }
+h2 { font-size: 120%; }
+h3 { font-size: 110%; }
+h4 { font-size: 107%; }
+h5 { font-size: 103%; }
+h6 { font-size: 100%; }
+p { padding: 0 0.5em; }
+'''
 
 STYLESHEET = os.path.join(os.path.expanduser('~/.mutt'),
                           'markdown2html.css')
 if os.path.exists(STYLESHEET):
     DEFAULT_CSS += open(STYLESHEET).read()
 
 
 STYLESHEET = os.path.join(os.path.expanduser('~/.mutt'),
                           'markdown2html.css')
 if os.path.exists(STYLESHEET):
     DEFAULT_CSS += open(STYLESHEET).read()
 
-HTML_DOCUMENT = '''<!DOCTYPE html>
-<html><head>
-<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
-<meta charset="utf-8"/>
-<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes"/>
-<title>HTML E-Mail</title>
-</head><body class="email">
-{htmlbody}
-</body></html>'''
-
-
 SIGNATURE_HTML = \
         '<div class="signature"><span class="leader">-- </span>{sig}</div>'
 
 
 SIGNATURE_HTML = \
         '<div class="signature"><span class="leader">-- </span>{sig}</div>'
 
 
+def _preprocess_signature(sig):
+    '''
+    Preprocess the signature before markdown processing.
+    '''
+    return sig
+
 def _preprocess_markdown(mdwn):
     '''
     Preprocess Markdown for handling by the converter.
 def _preprocess_markdown(mdwn):
     '''
     Preprocess Markdown for handling by the converter.
@@ -98,7 +119,22 @@ def _preprocess_markdown(mdwn):
     # convert hard line breaks within paragraphs to 2 trailing spaces, which
     # is the markdown way of representing hard line breaks. Note how the
     # regexp will not match between paragraphs.
     # convert hard line breaks within paragraphs to 2 trailing spaces, which
     # is the markdown way of representing hard line breaks. Note how the
     # regexp will not match between paragraphs.
-    ret = re.sub(r'(\S)\n(\s*\S)', r'\g<1>  \n\g<2>', mdwn, re.MULTILINE)
+    ret = re.sub(r'(\S)\n(\s*\S)', r'\g<1>  \n\g<2>', mdwn, flags=re.MULTILINE)
+
+    # Clients like Thunderbird need the leading '>' to be able to properly
+    # create nested quotes, so we duplicate the symbol, the first instance
+    # will tell pandoc to create a blockquote, while the second instance will
+    # be a <span> containing the character, along with a class that causes CSS
+    # to actually hide it from display. However, this does not work with the
+    # text-mode HTML2text converters, and so it's left commented for now.
+    #ret = re.sub(r'\n>', r'  \n>[>]{.quotechar}', ret, flags=re.MULTILINE)
+
+    # With the autolink_bare_uris extension, we do not need to put links into
+    # angle brackets to have them converted, so let's conserve the brackets
+    # when used around email addresses. Note that this needs a postprocessing
+    # hack because the pandoc autolink converted includes the ambersand
+    # (https://github.com/jgm/pandoc/issues/7398).
+    ret = re.sub(r'<([^@]+@.+\.[^>]+)>', r'&lt;\g<1> -PANDOC_BUG_7398-&gt;', ret)
 
     return ret
 
 
     return ret
 
@@ -153,13 +189,13 @@ def _identify_quotes_for_later(mdwn):
         elif prev and re.match(r'^.+:\s*$', prev) and cur.startswith('>'):
             ret.append(re.sub(r'^(\s*>\s*)+(.+)',
                               r'\g<1>{.quoteinitial}\g<2>',
         elif prev and re.match(r'^.+:\s*$', prev) and cur.startswith('>'):
             ret.append(re.sub(r'^(\s*>\s*)+(.+)',
                               r'\g<1>{.quoteinitial}\g<2>',
-                              cur, re.MULTILINE))
+                              cur, flags=re.MULTILINE))
 
         # All other occurrences of blockquotes get the "subsequent" marker:
 
         # All other occurrences of blockquotes get the "subsequent" marker:
-        elif cur.startswith('>') and not prev.startswith('>'):
+        elif cur.startswith('>') and prev and not prev.startswith('>'):
             ret.append(re.sub(r'^((?:\s*>\s*)+)(.+)',
                               r'\g<1>{.quotesubsequent}\g<2>',
             ret.append(re.sub(r'^((?:\s*>\s*)+)(.+)',
                               r'\g<1>{.quotesubsequent}\g<2>',
-                              cur, re.MULTILINE))
+                              cur, flags=re.MULTILINE))
 
         else: # pass through everything else.
             ret.append(cur)
 
         else: # pass through everything else.
             ret.append(cur)
@@ -174,14 +210,14 @@ def _reformat_quotes(html):
     '''
     ret = html.replace('<p>{.quotelead}', '<p class="quotelead">')
     ret = re.sub(r'<blockquote>\n((?:<blockquote>\n)*)<p>(?:\{\.quote(\w+)\})',
     '''
     ret = html.replace('<p>{.quotelead}', '<p class="quotelead">')
     ret = re.sub(r'<blockquote>\n((?:<blockquote>\n)*)<p>(?:\{\.quote(\w+)\})',
-                 r'<blockquote class="quote \g<2>">\n\g<1><p>', ret, re.MULTILINE)
+                 r'<blockquote class="quote \g<2>">\n\g<1><p>', ret, flags=re.MULTILINE)
     return ret
 
 
 
 def _convert_with_pandoc(mdwn, inputfmt='markdown', outputfmt='html5',
                          ext_enabled=None, ext_disabled=None,
     return ret
 
 
 
 def _convert_with_pandoc(mdwn, inputfmt='markdown', outputfmt='html5',
                          ext_enabled=None, ext_disabled=None,
-                         standalone=True, title="HTML E-Mail"):
+                         standalone=True, selfcontained=True, title=None):
     '''
     Invoke pandoc to do the actual conversion of Markdown to HTML5.
     '''
     '''
     Invoke pandoc to do the actual conversion of Markdown to HTML5.
     '''
@@ -208,10 +244,12 @@ def _convert_with_pandoc(mdwn, inputfmt='markdown', outputfmt='html5',
                        'inline_notes',
                        'emoji',
                        'tex_math_double_backslash',
                        'inline_notes',
                        'emoji',
                        'tex_math_double_backslash',
+                       'autolink_bare_uris'
                       ]
     if not ext_disabled:
         ext_disabled = [ 'tex_math_single_backslash',
                          'tex_math_dollars',
                       ]
     if not ext_disabled:
         ext_disabled = [ 'tex_math_single_backslash',
                          'tex_math_dollars',
+                         'smart',
                          'raw_html'
                        ]
 
                          'raw_html'
                        ]
 
@@ -222,6 +260,8 @@ def _convert_with_pandoc(mdwn, inputfmt='markdown', outputfmt='html5',
     args = []
     if standalone:
         args.append('--standalone')
     args = []
     if standalone:
         args.append('--standalone')
+    if selfcontained:
+        args.append('--self-contained')
     if title:
         args.append(f'--metadata=pagetitle:"{title}"')
 
     if title:
         args.append(f'--metadata=pagetitle:"{title}"')
 
@@ -240,6 +280,10 @@ def _postprocess_html(html):
     '''
     Postprocess the generated and styled HTML.
     '''
     '''
     Postprocess the generated and styled HTML.
     '''
+
+    # Preprocessing leaves a sentinel to work around
+    # https://github.com/jgm/pandoc/issues/7398, and so we need to remove it:
+    html = html.replace('</a> -PANDOC_BUG_7398-&gt;', '</a>&gt;')
     return html
 
 
     return html
 
 
@@ -259,14 +303,19 @@ def convert_markdown_to_html(mdwn):
     if body:
         body = _preprocess_markdown(body)
         body = _identify_quotes_for_later(body)
     if body:
         body = _preprocess_markdown(body)
         body = _identify_quotes_for_later(body)
-        html = _convert_with_pandoc(body, standalone=False)
+        html = _convert_with_pandoc(body, standalone=True, selfcontained=True,
+                                    title=None)
+        html = html.replace('<title>Untitled</title>\n','')
         html = _reformat_quotes(html)
 
     if sig:
         html = _reformat_quotes(html)
 
     if sig:
+        sig = _preprocess_signature(sig)
         sig = _preprocess_markdown(sig)
         sig = _preprocess_markdown(sig)
-        html += SIGNATURE_HTML.format(sig='<br/>'.join(sig.splitlines()))
+        sig = _convert_with_pandoc(sig, standalone=False, selfcontained=False)
+        sig = SIGNATURE_HTML.format(sig='<br/>'.join(sig.splitlines()))
+        eob = html.find('</body>')
+        html = f'{html[:eob]}{sig}\n{html[eob:]}'
 
 
-    html = HTML_DOCUMENT.format(htmlbody=html)
     html = _apply_styling(html)
     html = _postprocess_html(html)
 
     html = _apply_styling(html)
     html = _postprocess_html(html)
 
mutt configuration

Legalese

All content available in this repository is copyright © martin f. krafft, unless otherwise noted.

All files and their content are released under the terms of the Artistic Licence 2.0, unless otherwise noted.

The operator of this repository shall not be held liable for offending content in pages linking to or linked from these page, nor does he endorse their content unless stated otherwise.