2013-01-27 22:11:34 +00:00
|
|
|
|
;;; ox-md.el --- Markdown Back-End for Org Export Engine
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
2014-01-07 13:18:17 +00:00
|
|
|
|
;; Copyright (C) 2012-2014 Free Software Foundation, Inc.
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
;; Author: Nicolas Goaziou <n.goaziou@gmail.com>
|
2013-03-07 13:44:58 +00:00
|
|
|
|
;; Keywords: org, wp, markdown
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
Backport changes from Emacs revs 115081 and 115082
2013-11-12 Stefan Monnier <monnier@iro.umontreal.ca>
Address some byte-compiler warnings.
* ob-abc.el (org-babel-expand-body:abc): Use dolist.
(org-babel-execute:abc): Fix regexp quoting.
* ob-calc.el (org--var-syms): Rename from `var-syms'.
* ob-lilypond.el (ly-compile-lilyfile): Remove redundant let-binding.
* ob-table.el (sbe): Move debug declaration.
* org-clock.el (org--msg-extra): Rename from `msg-extra'.
* org.el (org-version): Avoid var name starting with _.
(org-inhibit-startup, org-called-with-limited-levels)
(org-link-search-inhibit-query, org-time-was-given)
(org-end-time-was-given, org-def, org-defdecode, org-with-time):
* org-colview.el (org-agenda-overriding-columns-format):
* org-agenda.el (org-agenda-multi, org-depend-tag-blocked)
(org-agenda-show-log-scoped):
* ob-python.el (py-which-bufname, python-shell-buffer-name):
* ob-haskell.el (org-export-copy-to-kill-ring):
* ob-exp.el (org-link-search-inhibit-query):
* ob-R.el (ess-eval-visibly-p):
* ob-core.el (org-src-window-setup): Declare before use.
(org-babel-expand-noweb-references): Remove unused `blocks-in-buffer'.
* ox-odt.el (org-odt-hfy-face-to-css):
* org-src.el (org-src-associate-babel-session, org-src-get-lang-mode):
* org-bibtex.el (org-bibtex-get, org-bibtex-ask, org-bibtex)
(org-bibtex-check):
* ob-tangle.el (org-babel-tangle, org-babel-spec-to-string)
(org-babel-tangle-single-block, org-babel-tangle-comment-links):
* ob-table.el (sbe):
* ob-sqlite.el (org-babel-sqlite-expand-vars):
* ob-sql.el (org-babel-sql-expand-vars):
* ob-shen.el (org-babel-execute:shen):
* ob-sh.el (org-babel-execute:sh, org-babel-sh-evaluate):
* ob-scala.el (org-babel-scala-evaluate):
* ob-ruby.el (org-babel-ruby-table-or-string)
(org-babel-ruby-evaluate):
* ob-python.el (org-babel-python-table-or-string)
(org-babel-python-evaluate-external-process)
(org-babel-python-evaluate-session):
* ob-picolisp.el (org-babel-execute:picolisp):
* ob-perl.el (org-babel-perl-evaluate):
* ob-maxima.el (org-babel-execute:maxima):
* ob-lisp.el (org-babel-execute:lisp):
* ob-java.el (org-babel-execute:java):
* ob-io.el (org-babel-io-evaluate):
* ob-haskell.el (org-babel-execute:haskell):
* ob-fortran.el (org-babel-execute:fortran):
* ob-exp.el (org-babel-exp-code):
* ob-emacs-lisp.el (org-babel-execute:emacs-lisp):
* ob-ditaa.el (org-babel-execute:ditaa):
* ob-core.el (org-babel-execute-src-block, org-babel-sha1-hash)
(org-babel-parse-header-arguments, org-babel-reassemble-table)
(org-babel-goto-src-block-head, org-babel-mark-block)
(org-babel-expand-noweb-references, org-babel-script-escape)
(org-babel-process-file-name):
* ob-clojure.el (org-babel-execute:clojure):
* ob-calc.el (org-babel-execute:calc):
* ob-awk.el (org-babel-execute:awk):
* ob-abc.el (org-babel-execute:abc):
* ob-R.el (org-babel-expand-body:R):
* ob-C.el (org-babel-C-execute): Avoid deprecated ((lambda) ...).
2013-11-12 Glenn Morris <rgm@gnu.org>
* ox-html.el (org-html-scripts): Add 2013 to copyright years.
(org-html-infojs-template): Copyright holder to FSF.
2013-11-12 19:57:31 +00:00
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
|
|
|
2013-02-23 08:56:24 +00:00
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
2012-07-25 21:04:36 +00:00
|
|
|
|
;; it under the terms of the GNU General Public License as published by
|
|
|
|
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
|
|
|
|
;; (at your option) any later version.
|
|
|
|
|
|
|
2013-02-23 08:56:24 +00:00
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
2012-07-25 21:04:36 +00:00
|
|
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
|
;; GNU General Public License for more details.
|
|
|
|
|
|
|
|
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
2013-02-23 08:56:24 +00:00
|
|
|
|
;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
;;; Commentary:
|
|
|
|
|
|
|
2013-11-17 08:12:41 +00:00
|
|
|
|
;; This library implements a Markdown back-end (vanilla flavor) for
|
2013-10-20 08:58:30 +00:00
|
|
|
|
;; Org exporter, based on `html' back-end. See Org manual for more
|
|
|
|
|
|
;; information.
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
;;; Code:
|
|
|
|
|
|
|
2013-02-09 17:25:57 +00:00
|
|
|
|
(eval-when-compile (require 'cl))
|
2013-01-27 22:11:34 +00:00
|
|
|
|
(require 'ox-html)
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
2012-07-27 20:52:01 +00:00
|
|
|
|
|
|
|
|
|
|
;;; User-Configurable Variables
|
|
|
|
|
|
|
|
|
|
|
|
(defgroup org-export-md nil
|
|
|
|
|
|
"Options specific to Markdown export back-end."
|
|
|
|
|
|
:tag "Org Markdown"
|
|
|
|
|
|
:group 'org-export
|
2013-03-06 16:31:28 +00:00
|
|
|
|
:version "24.4"
|
|
|
|
|
|
:package-version '(Org . "8.0"))
|
2012-07-27 20:52:01 +00:00
|
|
|
|
|
|
|
|
|
|
(defcustom org-md-headline-style 'atx
|
|
|
|
|
|
"Style used to format headlines.
|
2012-07-27 22:49:58 +00:00
|
|
|
|
This variable can be set to either `atx' or `setext'."
|
2012-07-27 20:52:01 +00:00
|
|
|
|
:group 'org-export-md
|
|
|
|
|
|
:type '(choice
|
|
|
|
|
|
(const :tag "Use \"atx\" style" atx)
|
|
|
|
|
|
(const :tag "Use \"Setext\" style" setext)))
|
|
|
|
|
|
|
|
|
|
|
|
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
;;; Define Back-End
|
|
|
|
|
|
|
2013-03-19 15:24:40 +00:00
|
|
|
|
(org-export-define-derived-backend 'md 'html
|
|
|
|
|
|
:export-block '("MD" "MARKDOWN")
|
|
|
|
|
|
:filters-alist '((:filter-parse-tree . org-md-separate-elements))
|
2012-09-09 11:08:52 +00:00
|
|
|
|
:menu-entry
|
2013-03-19 15:24:40 +00:00
|
|
|
|
'(?m "Export to Markdown"
|
|
|
|
|
|
((?M "To temporary buffer"
|
|
|
|
|
|
(lambda (a s v b) (org-md-export-as-markdown a s v)))
|
|
|
|
|
|
(?m "To file" (lambda (a s v b) (org-md-export-to-markdown a s v)))
|
|
|
|
|
|
(?o "To file and open"
|
|
|
|
|
|
(lambda (a s v b)
|
|
|
|
|
|
(if a (org-md-export-to-markdown t s v)
|
|
|
|
|
|
(org-open-file (org-md-export-to-markdown nil s v)))))))
|
|
|
|
|
|
:translate-alist '((bold . org-md-bold)
|
|
|
|
|
|
(code . org-md-verbatim)
|
|
|
|
|
|
(comment . (lambda (&rest args) ""))
|
|
|
|
|
|
(comment-block . (lambda (&rest args) ""))
|
|
|
|
|
|
(example-block . org-md-example-block)
|
|
|
|
|
|
(fixed-width . org-md-example-block)
|
|
|
|
|
|
(footnote-definition . ignore)
|
|
|
|
|
|
(footnote-reference . ignore)
|
|
|
|
|
|
(headline . org-md-headline)
|
|
|
|
|
|
(horizontal-rule . org-md-horizontal-rule)
|
|
|
|
|
|
(inline-src-block . org-md-verbatim)
|
2014-01-21 22:35:34 +00:00
|
|
|
|
(inner-template . org-md-inner-template)
|
2013-03-19 15:24:40 +00:00
|
|
|
|
(italic . org-md-italic)
|
|
|
|
|
|
(item . org-md-item)
|
|
|
|
|
|
(line-break . org-md-line-break)
|
|
|
|
|
|
(link . org-md-link)
|
|
|
|
|
|
(paragraph . org-md-paragraph)
|
|
|
|
|
|
(plain-list . org-md-plain-list)
|
|
|
|
|
|
(plain-text . org-md-plain-text)
|
|
|
|
|
|
(quote-block . org-md-quote-block)
|
|
|
|
|
|
(quote-section . org-md-example-block)
|
|
|
|
|
|
(section . org-md-section)
|
|
|
|
|
|
(src-block . org-md-example-block)
|
|
|
|
|
|
(template . org-md-template)
|
|
|
|
|
|
(verbatim . org-md-verbatim)))
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;; Filters
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-separate-elements (tree backend info)
|
2014-01-21 22:35:34 +00:00
|
|
|
|
"Fix blank lines between elements.
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
TREE is the parse tree being exported. BACKEND is the export
|
|
|
|
|
|
back-end used. INFO is a plist used as a communication channel.
|
|
|
|
|
|
|
2014-01-21 22:35:34 +00:00
|
|
|
|
Make sure there's no blank line before a plain list, unless it is
|
|
|
|
|
|
located right after a paragraph. Otherwise, add a blank line
|
|
|
|
|
|
between elements. Blank lines between items are preserved.
|
|
|
|
|
|
|
2012-07-25 21:04:36 +00:00
|
|
|
|
Assume BACKEND is `md'."
|
2014-01-21 22:35:34 +00:00
|
|
|
|
(org-element-map tree (remq 'item org-element-all-elements)
|
2013-01-27 22:11:34 +00:00
|
|
|
|
(lambda (elem)
|
2014-01-21 22:35:34 +00:00
|
|
|
|
(org-element-put-property
|
|
|
|
|
|
elem :post-blank
|
|
|
|
|
|
(if (and (eq (org-element-type (org-export-get-next-element elem info))
|
|
|
|
|
|
'plain-list)
|
|
|
|
|
|
(not (and (eq (org-element-type elem) 'paragraph)
|
|
|
|
|
|
(org-export-get-previous-element elem info))))
|
|
|
|
|
|
0
|
|
|
|
|
|
1))))
|
2012-07-25 21:04:36 +00:00
|
|
|
|
;; Return updated tree.
|
|
|
|
|
|
tree)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;; Transcode Functions
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Bold
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-bold (bold contents info)
|
|
|
|
|
|
"Transcode BOLD object into Markdown format.
|
|
|
|
|
|
CONTENTS is the text within bold markup. INFO is a plist used as
|
|
|
|
|
|
a communication channel."
|
|
|
|
|
|
(format "**%s**" contents))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Code and Verbatim
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-verbatim (verbatim contents info)
|
|
|
|
|
|
"Transcode VERBATIM object into Markdown format.
|
|
|
|
|
|
CONTENTS is nil. INFO is a plist used as a communication
|
|
|
|
|
|
channel."
|
|
|
|
|
|
(let ((value (org-element-property :value verbatim)))
|
|
|
|
|
|
(format (cond ((not (string-match "`" value)) "`%s`")
|
|
|
|
|
|
((or (string-match "\\``" value)
|
|
|
|
|
|
(string-match "`\\'" value))
|
|
|
|
|
|
"`` %s ``")
|
|
|
|
|
|
(t "``%s``"))
|
|
|
|
|
|
value)))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Example Block and Src Block
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-example-block (example-block contents info)
|
|
|
|
|
|
"Transcode EXAMPLE-BLOCK element into Markdown format.
|
|
|
|
|
|
CONTENTS is nil. INFO is a plist used as a communication
|
|
|
|
|
|
channel."
|
|
|
|
|
|
(replace-regexp-in-string
|
|
|
|
|
|
"^" " "
|
|
|
|
|
|
(org-remove-indentation
|
|
|
|
|
|
(org-element-property :value example-block))))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Headline
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-headline (headline contents info)
|
|
|
|
|
|
"Transcode HEADLINE element into Markdown format.
|
|
|
|
|
|
CONTENTS is the headline contents. INFO is a plist used as
|
|
|
|
|
|
a communication channel."
|
|
|
|
|
|
(unless (org-element-property :footnote-section-p headline)
|
2012-07-27 20:52:01 +00:00
|
|
|
|
(let* ((level (org-export-get-relative-level headline info))
|
|
|
|
|
|
(title (org-export-data (org-element-property :title headline) info))
|
|
|
|
|
|
(todo (and (plist-get info :with-todo-keywords)
|
|
|
|
|
|
(let ((todo (org-element-property :todo-keyword
|
|
|
|
|
|
headline)))
|
2012-07-27 21:05:34 +00:00
|
|
|
|
(and todo (concat (org-export-data todo info) " ")))))
|
2012-07-27 20:52:01 +00:00
|
|
|
|
(tags (and (plist-get info :with-tags)
|
|
|
|
|
|
(let ((tag-list (org-export-get-tags headline info)))
|
|
|
|
|
|
(and tag-list
|
2012-07-27 21:05:34 +00:00
|
|
|
|
(format " :%s:"
|
2012-07-27 20:52:01 +00:00
|
|
|
|
(mapconcat 'identity tag-list ":"))))))
|
2012-07-27 21:05:34 +00:00
|
|
|
|
(priority
|
|
|
|
|
|
(and (plist-get info :with-priority)
|
|
|
|
|
|
(let ((char (org-element-property :priority headline)))
|
|
|
|
|
|
(and char (format "[#%c] " char)))))
|
|
|
|
|
|
;; Headline text without tags.
|
|
|
|
|
|
(heading (concat todo priority title)))
|
2012-07-27 20:52:01 +00:00
|
|
|
|
(cond
|
2013-02-23 12:47:44 +00:00
|
|
|
|
;; Cannot create a headline. Fall-back to a list.
|
2012-07-27 20:52:01 +00:00
|
|
|
|
((or (org-export-low-level-p headline info)
|
|
|
|
|
|
(not (memq org-md-headline-style '(atx setext)))
|
|
|
|
|
|
(and (eq org-md-headline-style 'atx) (> level 6))
|
|
|
|
|
|
(and (eq org-md-headline-style 'setext) (> level 2)))
|
|
|
|
|
|
(let ((bullet
|
|
|
|
|
|
(if (not (org-export-numbered-headline-p headline info)) "-"
|
|
|
|
|
|
(concat (number-to-string
|
|
|
|
|
|
(car (last (org-export-get-headline-number
|
|
|
|
|
|
headline info))))
|
|
|
|
|
|
"."))))
|
2012-07-27 21:05:34 +00:00
|
|
|
|
(concat bullet (make-string (- 4 (length bullet)) ? ) heading tags
|
|
|
|
|
|
"\n\n"
|
2012-07-27 20:52:01 +00:00
|
|
|
|
(and contents
|
|
|
|
|
|
(replace-regexp-in-string "^" " " contents)))))
|
|
|
|
|
|
;; Use "Setext" style.
|
|
|
|
|
|
((eq org-md-headline-style 'setext)
|
2012-07-27 21:05:34 +00:00
|
|
|
|
(concat heading tags "\n"
|
2012-07-27 20:52:01 +00:00
|
|
|
|
(make-string (length heading) (if (= level 1) ?= ?-))
|
|
|
|
|
|
"\n\n"
|
|
|
|
|
|
contents))
|
|
|
|
|
|
;; Use "atx" style.
|
2012-07-27 21:05:34 +00:00
|
|
|
|
(t (concat (make-string level ?#) " " heading tags "\n\n" contents))))))
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Horizontal Rule
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-horizontal-rule (horizontal-rule contents info)
|
|
|
|
|
|
"Transcode HORIZONTAL-RULE element into Markdown format.
|
|
|
|
|
|
CONTENTS is the horizontal rule contents. INFO is a plist used
|
|
|
|
|
|
as a communication channel."
|
|
|
|
|
|
"---")
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Italic
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-italic (italic contents info)
|
|
|
|
|
|
"Transcode ITALIC object into Markdown format.
|
|
|
|
|
|
CONTENTS is the text within italic markup. INFO is a plist used
|
|
|
|
|
|
as a communication channel."
|
|
|
|
|
|
(format "*%s*" contents))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Item
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-item (item contents info)
|
|
|
|
|
|
"Transcode ITEM element into Markdown format.
|
|
|
|
|
|
CONTENTS is the item contents. INFO is a plist used as
|
|
|
|
|
|
a communication channel."
|
|
|
|
|
|
(let* ((type (org-element-property :type (org-export-get-parent item)))
|
|
|
|
|
|
(struct (org-element-property :structure item))
|
|
|
|
|
|
(bullet (if (not (eq type 'ordered)) "-"
|
|
|
|
|
|
(concat (number-to-string
|
|
|
|
|
|
(car (last (org-list-get-item-number
|
|
|
|
|
|
(org-element-property :begin item)
|
|
|
|
|
|
struct
|
|
|
|
|
|
(org-list-prevs-alist struct)
|
|
|
|
|
|
(org-list-parents-alist struct)))))
|
|
|
|
|
|
"."))))
|
|
|
|
|
|
(concat bullet
|
|
|
|
|
|
(make-string (- 4 (length bullet)) ? )
|
|
|
|
|
|
(case (org-element-property :checkbox item)
|
|
|
|
|
|
(on "[X] ")
|
|
|
|
|
|
(trans "[-] ")
|
|
|
|
|
|
(off "[ ] "))
|
|
|
|
|
|
(let ((tag (org-element-property :tag item)))
|
|
|
|
|
|
(and tag (format "**%s:** "(org-export-data tag info))))
|
2014-01-08 21:47:10 +00:00
|
|
|
|
(and contents
|
|
|
|
|
|
(org-trim (replace-regexp-in-string "^" " " contents))))))
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Line Break
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-line-break (line-break contents info)
|
|
|
|
|
|
"Transcode LINE-BREAK object into Markdown format.
|
|
|
|
|
|
CONTENTS is nil. INFO is a plist used as a communication
|
|
|
|
|
|
channel."
|
2012-12-12 21:48:06 +00:00
|
|
|
|
" \n")
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Link
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-link (link contents info)
|
|
|
|
|
|
"Transcode LINE-BREAK object into Markdown format.
|
|
|
|
|
|
CONTENTS is the link's description. INFO is a plist used as
|
|
|
|
|
|
a communication channel."
|
|
|
|
|
|
(let ((--link-org-files-as-html-maybe
|
|
|
|
|
|
(function
|
|
|
|
|
|
(lambda (raw-path info)
|
|
|
|
|
|
;; Treat links to `file.org' as links to `file.html', if
|
2013-01-27 22:11:34 +00:00
|
|
|
|
;; needed. See `org-html-link-org-files-as-html'.
|
2012-07-25 21:04:36 +00:00
|
|
|
|
(cond
|
2013-01-27 22:11:34 +00:00
|
|
|
|
((and org-html-link-org-files-as-html
|
2012-07-25 21:04:36 +00:00
|
|
|
|
(string= ".org"
|
|
|
|
|
|
(downcase (file-name-extension raw-path "."))))
|
|
|
|
|
|
(concat (file-name-sans-extension raw-path) "."
|
|
|
|
|
|
(plist-get info :html-extension)))
|
|
|
|
|
|
(t raw-path)))))
|
|
|
|
|
|
(type (org-element-property :type link)))
|
|
|
|
|
|
(cond ((member type '("custom-id" "id"))
|
|
|
|
|
|
(let ((destination (org-export-resolve-id-link link info)))
|
|
|
|
|
|
(if (stringp destination) ; External file.
|
|
|
|
|
|
(let ((path (funcall --link-org-files-as-html-maybe
|
|
|
|
|
|
destination info)))
|
|
|
|
|
|
(if (not contents) (format "<%s>" path)
|
|
|
|
|
|
(format "[%s](%s)" contents path)))
|
|
|
|
|
|
(concat
|
|
|
|
|
|
(and contents (concat contents " "))
|
|
|
|
|
|
(format "(%s)"
|
|
|
|
|
|
(format (org-export-translate "See section %s" :html info)
|
|
|
|
|
|
(mapconcat 'number-to-string
|
|
|
|
|
|
(org-export-get-headline-number
|
|
|
|
|
|
destination info)
|
|
|
|
|
|
".")))))))
|
2013-01-27 22:11:34 +00:00
|
|
|
|
((org-export-inline-image-p link org-html-inline-image-rules)
|
2012-12-08 18:30:27 +00:00
|
|
|
|
(let ((path (let ((raw-path (org-element-property :path link)))
|
|
|
|
|
|
(if (not (file-name-absolute-p raw-path)) raw-path
|
2014-02-08 14:45:25 +00:00
|
|
|
|
(expand-file-name raw-path))))
|
|
|
|
|
|
(caption (org-export-data
|
|
|
|
|
|
(org-export-get-caption
|
|
|
|
|
|
(org-export-get-parent-element link)) info)))
|
|
|
|
|
|
(format ""
|
|
|
|
|
|
(if (not (org-string-nw-p caption)) path
|
|
|
|
|
|
(format "%s \"%s\"" path caption)))))
|
2012-07-25 21:04:36 +00:00
|
|
|
|
((string= type "coderef")
|
|
|
|
|
|
(let ((ref (org-element-property :path link)))
|
|
|
|
|
|
(format (org-export-get-coderef-format ref contents)
|
|
|
|
|
|
(org-export-resolve-coderef ref info))))
|
|
|
|
|
|
((equal type "radio")
|
|
|
|
|
|
(let ((destination (org-export-resolve-radio-link link info)))
|
|
|
|
|
|
(org-export-data (org-element-contents destination) info)))
|
|
|
|
|
|
((equal type "fuzzy")
|
|
|
|
|
|
(let ((destination (org-export-resolve-fuzzy-link link info)))
|
2013-04-04 18:35:05 +00:00
|
|
|
|
(if (org-string-nw-p contents) contents
|
|
|
|
|
|
(when destination
|
|
|
|
|
|
(let ((number (org-export-get-ordinal destination info)))
|
|
|
|
|
|
(when number
|
|
|
|
|
|
(if (atom number) (number-to-string number)
|
|
|
|
|
|
(mapconcat 'number-to-string number "."))))))))
|
2012-07-25 21:04:36 +00:00
|
|
|
|
(t (let* ((raw-path (org-element-property :path link))
|
|
|
|
|
|
(path (cond
|
|
|
|
|
|
((member type '("http" "https" "ftp"))
|
|
|
|
|
|
(concat type ":" raw-path))
|
|
|
|
|
|
((equal type "file")
|
|
|
|
|
|
;; Treat links to ".org" files as ".html",
|
|
|
|
|
|
;; if needed.
|
|
|
|
|
|
(setq raw-path
|
|
|
|
|
|
(funcall --link-org-files-as-html-maybe
|
|
|
|
|
|
raw-path info))
|
|
|
|
|
|
;; If file path is absolute, prepend it
|
|
|
|
|
|
;; with protocol component - "file://".
|
|
|
|
|
|
(if (not (file-name-absolute-p raw-path)) raw-path
|
|
|
|
|
|
(concat "file://" (expand-file-name raw-path))))
|
|
|
|
|
|
(t raw-path))))
|
|
|
|
|
|
(if (not contents) (format "<%s>" path)
|
|
|
|
|
|
(format "[%s](%s)" contents path)))))))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Paragraph
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-paragraph (paragraph contents info)
|
|
|
|
|
|
"Transcode PARAGRAPH element into Markdown format.
|
|
|
|
|
|
CONTENTS is the paragraph contents. INFO is a plist used as
|
|
|
|
|
|
a communication channel."
|
2012-07-27 12:05:44 +00:00
|
|
|
|
(let ((first-object (car (org-element-contents paragraph))))
|
|
|
|
|
|
;; If paragraph starts with a #, protect it.
|
|
|
|
|
|
(if (and (stringp first-object) (string-match "\\`#" first-object))
|
2012-08-19 13:59:24 +00:00
|
|
|
|
(replace-regexp-in-string "\\`#" "\\#" contents nil t)
|
2012-07-27 12:05:44 +00:00
|
|
|
|
contents)))
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Plain List
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-plain-list (plain-list contents info)
|
|
|
|
|
|
"Transcode PLAIN-LIST element into Markdown format.
|
|
|
|
|
|
CONTENTS is the plain-list contents. INFO is a plist used as
|
|
|
|
|
|
a communication channel."
|
|
|
|
|
|
contents)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Plain Text
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-plain-text (text info)
|
|
|
|
|
|
"Transcode a TEXT string into Markdown format.
|
|
|
|
|
|
TEXT is the string to transcode. INFO is a plist holding
|
|
|
|
|
|
contextual information."
|
2012-10-26 22:36:00 +00:00
|
|
|
|
(when (plist-get info :with-smart-quotes)
|
|
|
|
|
|
(setq text (org-export-activate-smart-quotes text :html info)))
|
2012-07-27 12:05:44 +00:00
|
|
|
|
;; Protect ambiguous #. This will protect # at the beginning of
|
|
|
|
|
|
;; a line, but not at the beginning of a paragraph. See
|
|
|
|
|
|
;; `org-md-paragraph'.
|
|
|
|
|
|
(setq text (replace-regexp-in-string "\n#" "\n\\\\#" text))
|
2012-07-25 21:04:36 +00:00
|
|
|
|
;; Protect ambiguous !
|
|
|
|
|
|
(setq text (replace-regexp-in-string "\\(!\\)\\[" "\\\\!" text nil nil 1))
|
|
|
|
|
|
;; Protect `, *, _ and \
|
2012-10-26 22:36:00 +00:00
|
|
|
|
(setq text (replace-regexp-in-string "[`*_\\]" "\\\\\\&" text))
|
2012-07-25 21:04:36 +00:00
|
|
|
|
;; Handle special strings, if required.
|
|
|
|
|
|
(when (plist-get info :with-special-strings)
|
2013-01-27 22:11:34 +00:00
|
|
|
|
(setq text (org-html-convert-special-strings text)))
|
2012-07-25 21:04:36 +00:00
|
|
|
|
;; Handle break preservation, if required.
|
|
|
|
|
|
(when (plist-get info :preserve-breaks)
|
|
|
|
|
|
(setq text (replace-regexp-in-string "[ \t]*\n" " \n" text)))
|
|
|
|
|
|
;; Return value.
|
|
|
|
|
|
text)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Quote Block
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-quote-block (quote-block contents info)
|
|
|
|
|
|
"Transcode QUOTE-BLOCK element into Markdown format.
|
|
|
|
|
|
CONTENTS is the quote-block contents. INFO is a plist used as
|
|
|
|
|
|
a communication channel."
|
|
|
|
|
|
(replace-regexp-in-string
|
|
|
|
|
|
"^" "> "
|
|
|
|
|
|
(replace-regexp-in-string "\n\\'" "" contents)))
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Section
|
|
|
|
|
|
|
|
|
|
|
|
(defun org-md-section (section contents info)
|
|
|
|
|
|
"Transcode SECTION element into Markdown format.
|
|
|
|
|
|
CONTENTS is the section contents. INFO is a plist used as
|
|
|
|
|
|
a communication channel."
|
2012-07-27 12:43:12 +00:00
|
|
|
|
contents)
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;;; Template
|
|
|
|
|
|
|
2014-01-21 22:35:34 +00:00
|
|
|
|
(defun org-md-inner-template (contents info)
|
|
|
|
|
|
"Return body of document after converting it to Markdown syntax.
|
|
|
|
|
|
CONTENTS is the transcoded contents string. INFO is a plist
|
|
|
|
|
|
holding export options."
|
|
|
|
|
|
;; Make sure CONTENTS is separated from table of contents and
|
|
|
|
|
|
;; footnotes with at least a blank line.
|
|
|
|
|
|
(org-trim (org-html-inner-template (concat "\n" contents "\n") info)))
|
|
|
|
|
|
|
2012-07-25 21:04:36 +00:00
|
|
|
|
(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)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
;;; Interactive function
|
|
|
|
|
|
|
|
|
|
|
|
;;;###autoload
|
2012-12-02 16:24:19 +00:00
|
|
|
|
(defun org-md-export-as-markdown (&optional async subtreep visible-only)
|
2013-03-07 15:31:24 +00:00
|
|
|
|
"Export current buffer to a Markdown buffer.
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
If narrowing is active in the current buffer, only export its
|
|
|
|
|
|
narrowed part.
|
|
|
|
|
|
|
|
|
|
|
|
If a region is active, export that region.
|
|
|
|
|
|
|
2012-12-02 16:24:19 +00:00
|
|
|
|
A non-nil optional argument ASYNC means the process should happen
|
|
|
|
|
|
asynchronously. The resulting buffer should be accessible
|
|
|
|
|
|
through the `org-export-stack' interface.
|
|
|
|
|
|
|
2012-07-25 21:04:36 +00:00
|
|
|
|
When optional argument SUBTREEP is non-nil, export the sub-tree
|
|
|
|
|
|
at point, extracting information from the headline properties
|
|
|
|
|
|
first.
|
|
|
|
|
|
|
|
|
|
|
|
When optional argument VISIBLE-ONLY is non-nil, don't export
|
|
|
|
|
|
contents of hidden elements.
|
|
|
|
|
|
|
2012-07-26 12:51:45 +00:00
|
|
|
|
Export is done in a buffer named \"*Org MD Export*\", which will
|
|
|
|
|
|
be displayed when `org-export-show-temporary-export-buffer' is
|
|
|
|
|
|
non-nil."
|
2012-07-25 21:04:36 +00:00
|
|
|
|
(interactive)
|
Export back-ends: Apply changes to export functions
* contrib/lisp/ox-confluence.el (org-confluence-export-as-confluence):
* contrib/lisp/ox-deck.el (org-deck-export-as-html,
org-deck-export-to-html):
* contrib/lisp/ox-freemind.el (org-freemind-export-to-freemind):
* contrib/lisp/ox-groff.el (org-groff-export-to-groff,
org-groff-export-to-pdf):
* contrib/lisp/ox-koma-letter.el (org-koma-letter-export-as-latex,
org-koma-letter-export-to-latex, org-koma-letter-export-to-pdf):
* contrib/lisp/ox-rss.el (org-rss-export-as-rss,
org-rss-export-to-rss):
* contrib/lisp/ox-s5.el (org-s5-export-as-html,
org-s5-export-to-html):
* contrib/lisp/ox-taskjuggler.el (org-taskjuggler-export):
* lisp/ob-haskell.el:
* lisp/ox-ascii.el (org-ascii-export-as-ascii,
org-ascii-export-to-ascii):
* lisp/ox-beamer.el (org-beamer-export-as-latex,
org-beamer-export-to-latex, org-beamer-export-to-pdf):
* lisp/ox-html.el (org-html-export-as-html, org-html-export-to-html):
* lisp/ox-icalendar.el (org-icalendar-export-to-ics):
* lisp/ox-latex.el (org-latex-export-as-latex,
org-latex-export-to-pdf):
* lisp/ox-man.el (org-man-export-to-man, org-man-export-to-pdf):
* lisp/ox-md.el (org-md-export-as-markdown,
org-md-export-to-markdown):
* lisp/ox-odt.el (org-odt-export-to-odt):
* lisp/ox-org.el (org-org-export-as-org, org-org-export-to-org):
* lisp/ox-publish.el (org-publish-org-to):
* lisp/ox-texinfo.el (org-texinfo-export-to-texinfo,
org-texinfo-export-to-info):
* testing/lisp/test-ob-exp.el (test-ob-exp/org-babel-exp-src-blocks/w-no-file):
2013-08-07 08:35:42 +00:00
|
|
|
|
(org-export-to-buffer 'md "*Org MD Export*"
|
|
|
|
|
|
async subtreep visible-only nil nil (lambda () (text-mode))))
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
2013-04-06 17:09:38 +00:00
|
|
|
|
;;;###autoload
|
|
|
|
|
|
(defun org-md-convert-region-to-md ()
|
|
|
|
|
|
"Assume the current region has org-mode syntax, and convert it to Markdown.
|
|
|
|
|
|
This can be used in any buffer. For example, you can write an
|
|
|
|
|
|
itemized list in org-mode syntax in a Markdown buffer and use
|
|
|
|
|
|
this command to convert it."
|
|
|
|
|
|
(interactive)
|
|
|
|
|
|
(org-export-replace-region-by 'md))
|
|
|
|
|
|
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
;;;###autoload
|
2012-12-02 16:24:19 +00:00
|
|
|
|
(defun org-md-export-to-markdown (&optional async subtreep visible-only)
|
2012-07-25 21:04:36 +00:00
|
|
|
|
"Export current buffer to a Markdown file.
|
|
|
|
|
|
|
|
|
|
|
|
If narrowing is active in the current buffer, only export its
|
|
|
|
|
|
narrowed part.
|
|
|
|
|
|
|
|
|
|
|
|
If a region is active, export that region.
|
|
|
|
|
|
|
2012-12-02 16:24:19 +00:00
|
|
|
|
A non-nil optional argument ASYNC means the process should happen
|
|
|
|
|
|
asynchronously. The resulting file should be accessible through
|
|
|
|
|
|
the `org-export-stack' interface.
|
|
|
|
|
|
|
2012-07-25 21:04:36 +00:00
|
|
|
|
When optional argument SUBTREEP is non-nil, export the sub-tree
|
|
|
|
|
|
at point, extracting information from the headline properties
|
|
|
|
|
|
first.
|
|
|
|
|
|
|
|
|
|
|
|
When optional argument VISIBLE-ONLY is non-nil, don't export
|
|
|
|
|
|
contents of hidden elements.
|
|
|
|
|
|
|
|
|
|
|
|
Return output file's name."
|
|
|
|
|
|
(interactive)
|
2012-11-29 20:52:43 +00:00
|
|
|
|
(let ((outfile (org-export-output-file-name ".md" subtreep)))
|
Export back-ends: Apply changes to export functions
* contrib/lisp/ox-confluence.el (org-confluence-export-as-confluence):
* contrib/lisp/ox-deck.el (org-deck-export-as-html,
org-deck-export-to-html):
* contrib/lisp/ox-freemind.el (org-freemind-export-to-freemind):
* contrib/lisp/ox-groff.el (org-groff-export-to-groff,
org-groff-export-to-pdf):
* contrib/lisp/ox-koma-letter.el (org-koma-letter-export-as-latex,
org-koma-letter-export-to-latex, org-koma-letter-export-to-pdf):
* contrib/lisp/ox-rss.el (org-rss-export-as-rss,
org-rss-export-to-rss):
* contrib/lisp/ox-s5.el (org-s5-export-as-html,
org-s5-export-to-html):
* contrib/lisp/ox-taskjuggler.el (org-taskjuggler-export):
* lisp/ob-haskell.el:
* lisp/ox-ascii.el (org-ascii-export-as-ascii,
org-ascii-export-to-ascii):
* lisp/ox-beamer.el (org-beamer-export-as-latex,
org-beamer-export-to-latex, org-beamer-export-to-pdf):
* lisp/ox-html.el (org-html-export-as-html, org-html-export-to-html):
* lisp/ox-icalendar.el (org-icalendar-export-to-ics):
* lisp/ox-latex.el (org-latex-export-as-latex,
org-latex-export-to-pdf):
* lisp/ox-man.el (org-man-export-to-man, org-man-export-to-pdf):
* lisp/ox-md.el (org-md-export-as-markdown,
org-md-export-to-markdown):
* lisp/ox-odt.el (org-odt-export-to-odt):
* lisp/ox-org.el (org-org-export-as-org, org-org-export-to-org):
* lisp/ox-publish.el (org-publish-org-to):
* lisp/ox-texinfo.el (org-texinfo-export-to-texinfo,
org-texinfo-export-to-info):
* testing/lisp/test-ob-exp.el (test-ob-exp/org-babel-exp-src-blocks/w-no-file):
2013-08-07 08:35:42 +00:00
|
|
|
|
(org-export-to-file 'md outfile async subtreep visible-only)))
|
2012-07-25 21:04:36 +00:00
|
|
|
|
|
|
|
|
|
|
|
2013-01-27 22:11:34 +00:00
|
|
|
|
(provide 'ox-md)
|
|
|
|
|
|
|
|
|
|
|
|
;; Local variables:
|
|
|
|
|
|
;; generated-autoload-file: "org-loaddefs.el"
|
|
|
|
|
|
;; End:
|
|
|
|
|
|
|
|
|
|
|
|
;;; ox-md.el ends here
|