[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[O] [PATCH] Add TITLE export to ox-md

From: Jay Kamat
Subject: [O] [PATCH] Add TITLE export to ox-md
Date: Wed, 23 Aug 2017 23:32:55 -0400
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1 (gnu/linux)


Currently, the markdown org exporter does not export titles. For example, the
following org file:

#+TITLE: My Title
#+SUBTITLE: My Subtitle
#+OPTIONS: toc:nil

exports to an empty file. This patch adds title support to ox-md. Currently it
exports them as markdown headers. For example, the above org file will export

# My Title

## My Subtitle

Of course, the title can be suppressed by adding #+OPTIONS: title:nil.

The style used for the title export can be configured using the already existing
org-md-headline-style variable.

The markdown editor should support TITLE, but I'm not sure if this is the
'correct' way to support it. It seems like the simplest way for now. If people
want it, I could add a new option to add different title export formats.

There is an existing bug report and discussion at this issue tracker:

>From that issue, YAML front-matter is an option for title export, but I would
like to stay away from that (at least by default) since that dosen't seem to be
a feature in default markdown.

Feedback, suggestions, and feature requests are very much appreciated!


PS: Apologies if any part of this email is broken, I'm attempting to switch to 

>From fe45823c8b6da4ecae3347de4859127add03e253 Mon Sep 17 00:00:00 2001
From: Jay Kamat <address@hidden>
Date: Sun, 20 Aug 2017 19:01:29 -0400
Subject: [PATCH] ox-md.el: Add TITLE export to markdown export

* lisp/ox-md.el (org-md-template): Add title export to md template.
  Title will be exported as level 1 and 2 headers, as determined by

See https://github.com/larstvei/ox-gfm/issues/21 for an external bug report
 lisp/ox-md.el | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/lisp/ox-md.el b/lisp/ox-md.el
index ac94ba648..a552063e8 100644
--- a/lisp/ox-md.el
+++ b/lisp/ox-md.el
@@ -649,14 +649,26 @@ holding export options."
    ;; Footnotes section.
    (org-md--footnote-section info)))
-(defun org-md-template (contents _info)
+(defun org-md-template (contents info)
   "Return complete document string after Markdown conversion.
 CONTENTS is the transcoded contents string.  INFO is a plist used
 as a communication channel."
-  contents)
+  (concat
+    ;; Generate title and subtitle, if possible
+    (let ((title (and (plist-get info :with-title)
+                  (plist-get info :title)))
+          (subtitle (plist-get info :subtitle))
+          (style (plist-get info :md-headline-style)))
+      (when title
+       (concat
+         (org-md--headline-title style
+           1 (org-export-data title info))
+         (when subtitle
+           (org-md--headline-title style
+             2 (org-export-data subtitle info))))))
+    contents))
 ;;; Interactive function

reply via email to

[Prev in Thread] Current Thread [Next in Thread]