From: "Rohit Patnaik" <quanticle@quanticle.net>
To: "Ihor Radchenko" <yantar92@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: [Feature Request] Create an org-md-toplevel-hlevel variable to allow users to set the level of top level headings in markdown export
Date: Sun, 21 Aug 2022 06:07:48 -0500 [thread overview]
Message-ID: <b888e23b-67f5-45d6-9160-f1551f40de35@www.fastmail.com> (raw)
In-Reply-To: <87zgfzmk15.fsf@localhost>
[-- Attachment #1: Type: text/plain, Size: 410 bytes --]
> This contribution will be welcome.
I've attached a patch which implements the change. I followed the pattern that
ox-html uses to the greatest extent possible. I tested it by exporting org-mode
files to markdown with the table of contents both enabled and disabled. I
didn't see any errors, and I was able to make the top level heading a level 2
(or even level 3) heading rather than level 1.
Thanks,
Rohit
[-- Attachment #2: 0001-Added-top-level-header-setting-for-md-export.patch --]
[-- Type: application/octet-stream, Size: 3072 bytes --]
From 185c43c2d7c15cd6df44c448d60bc88ea2a47402 Mon Sep 17 00:00:00 2001
From: Rohit Patnaik <quanticle@quanticle.net>
Date: Sun, 21 Aug 2022 00:20:03 -0500
Subject: [PATCH] Added top level header setting for md export
This commit adds a customization, org-md-toplevel-hlevel, which sets the
heading level of top-level headings in the exported markdown. This makes
markdown export behave more like HTML export, which reads
org-html-toplevel-hlevel to decide what the top level heading for HTML
export should be.
---
lisp/ox-md.el | 23 +++++++++++++++++++----
1 file changed, 19 insertions(+), 4 deletions(-)
diff --git a/lisp/ox-md.el b/lisp/ox-md.el
index 50db53910..7b9110890 100644
--- a/lisp/ox-md.el
+++ b/lisp/ox-md.el
@@ -71,6 +71,18 @@ The %s will be replaced by the footnote reference itself."
:version "26.1"
:package-version '(Org . "9.0"))
+(defcustom org-md-toplevel-hlevel 1
+ "The markdown heading level to use for level 1 headings in markdown export.
+If this is 1, the top level headings will be level 1 markdown headings. If this
+is 2, then top level headings will be level 2 markdown headings. By default
+this is 1, so that org-mode headings correspond to the same level markdown
+headings. Incrementing this value may be helpful creating markdown for
+inclusion in another document or application that reserves top-level headings
+for its own use."
+ :group 'org-export-md
+ :type 'string)
+
+
\f
;;; Define Back-End
@@ -120,7 +132,8 @@ The %s will be replaced by the footnote reference itself."
:options-alist
'((:md-footnote-format nil nil org-md-footnote-format)
(:md-footnotes-section nil nil org-md-footnotes-section)
- (:md-headline-style nil nil org-md-headline-style)))
+ (:md-headline-style nil nil org-md-headline-style)
+ (:md-toplevel-hlevel nil nil org-md-toplevel-hlevel)))
\f
;;; Filters
@@ -229,9 +242,10 @@ When optional argument SCOPE is non-nil, build a table of
contents according to the specified element."
(concat
(unless scope
- (let ((style (plist-get info :md-headline-style))
+ (let ((level (plist-get info :md-toplevel-hlevel))
+ (style (plist-get info :md-headline-style))
(title (org-html--translate "Table of Contents" info)))
- (org-md--headline-title style 1 title nil)))
+ (org-md--headline-title style level title nil)))
(mapconcat
(lambda (headline)
(let* ((indentation
@@ -350,7 +364,8 @@ CONTENTS is nil. INFO is a plist holding contextual information."
CONTENTS is the headline contents. INFO is a plist used as
a communication channel."
(unless (org-element-property :footnote-section-p headline)
- (let* ((level (org-export-get-relative-level headline info))
+ (let* ((level (+ (org-export-get-relative-level headline info)
+ (1- (plist-get info :md-toplevel-hlevel))))
(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
--
2.37.2.windows.2
next prev parent reply other threads:[~2022-08-21 11:09 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-08-19 20:20 [Feature Request] Create an org-md-toplevel-hlevel variable to allow users to set the level of top level headings in markdown export Rohit Patnaik
2022-08-20 7:49 ` Ihor Radchenko
2022-08-21 11:07 ` Rohit Patnaik [this message]
2022-08-21 14:26 ` Max Nikulin
[not found] ` <47b3902e-cc80-4317-a761-9301abd50b3c@www.fastmail.com>
2022-08-22 12:03 ` Max Nikulin
2022-08-22 2:59 ` Ihor Radchenko
[not found] ` <1335376b-0eeb-472c-8b8d-988eb0bdd04b@www.fastmail.com>
2022-08-26 13:07 ` Ihor Radchenko
2022-08-26 15:34 ` Rohit Patnaik
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b888e23b-67f5-45d6-9160-f1551f40de35@www.fastmail.com \
--to=quanticle@quanticle.net \
--cc=emacs-orgmode@gnu.org \
--cc=yantar92@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).