wilderjds
/
ox-hugo
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add support for Org TOC export option and keyword

Browse Source
master
Kaushal Modi 9 years ago
parent 8de0bbd612
commit f0fa731503
11 changed files with 673 additions and 12 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 44
      doc/content/doc/org-toc.md
  2. 38
      doc/ox-hugo-manual.org
  3. 128
      ox-hugo.el
  4. 74
      test/site/content-org/all-posts.org
  5. 49
      test/site/content/posts/post-with-toc-export-option-0.md
  6. 62
      test/site/content/posts/post-with-toc-export-option-2.md
  7. 49
      test/site/content/posts/post-with-toc-export-option-nil.md
  8. 65
      test/site/content/posts/post-with-toc-export-option-t.md
  9. 49
      test/site/content/posts/post-with-toc-keyword-0.md
  10. 62
      test/site/content/posts/post-with-toc-keyword-2.md
  11. 65
      test/site/content/posts/post-with-toc-keyword-6.md

44
doc/content/doc/org-toc.md
Unescape View File

@ -0,0 +1,44 @@
+++
title = "Table of Contents"
draft = false
[menu."org_to_hugo"]
weight = 3006
identifier = "table-of-contents"
+++
Hugo can automatically parse the Markdown content and auto-create a
Table of Contents. See its documentation on [Table of Contents](https://gohugo.io/content-management/toc/). So
`ox-hugo` doesn't generate the Org-parsed TOC by default.
The advantage of using Hugo-generated TOC is that it does not clutter
the Markdown source.
Though, the advantage of Org-generated TOC is that you get finer
control on:
- Where to include the TOC --- Location of the `#+TOC` keyword in the
Org content.
- How many headlines to include in the TOC --- _Example: `#+TOC:
headlines 2`_ or `:EXPORT_OPTIONS: toc:2`.
- Whether you want to **not** include a headline in the TOC --- Set the
`UNNUMBERED` property of that headline to `t`.
If you'd like to use the Org-generated TOC instead of the
Hugo-generated one, you can do it one of these many ways:
1. The default is to use the Hugo-generated TOC. But that can be
changed by setting `org-hugo-export-with-toc` variable to a non-nil
value, like `t` or `2`.
2. Org-generated TOC can be enabled per-post by either setting
`EXPORT_OPTIONS` subtree property (for subtree-based exports) or
the `OPTIONS` keyword (for file-based exports) to a non-nil value,
like `toc:t` or `toc:2`.
3. Above two options will insert the TOC between the front-matter and
the Markdown content. If you'd like to insert the Org-generated TOC
anywhere else in the post, you can do it using the `#+TOC`
keyword.. Example: `#+TOC: headlines 2`.
See Org manual [Table of Contents](http://orgmode.org/manual/Table-of-contents.html) section for more info.
_Note that `ox-hugo` does not support `#+TOC: listings` and `#+TOC:
tables`._

38
doc/ox-hugo-manual.org
Unescape View File

@ -1072,6 +1072,44 @@ categories set via =#+HUGO_CATEGORIES= / =EXPORT_HUGO_CATEGORIES=.
- [[https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/test/site/content-org/tags-and-categories.org][Org source]]
- Exported Markdown -- [[https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/test/site/content/posts/inheriting-tags.md][=inheriting-tags.md=]], [[https://raw.githubusercontent.com/kaushalmodi/ox-hugo/master/test/site/content/posts/overriding-tags.md][=overriding-tags.md=]]
- Hugo-generated HTML -- [[https://ox-hugo.scripter.co/test/posts/inheriting-tags/][Inheriting tags]], [[https://ox-hugo.scripter.co/test/posts/overriding-tags/][Overriding tags]]
*** Table of Contents
:PROPERTIES:
:EXPORT_FILE_NAME: org-toc
:END:
Hugo can automatically parse the Markdown content and auto-create a
Table of Contents. See its documentation on [[https://gohugo.io/content-management/toc/][Table of Contents]]. So
=ox-hugo= doesn't generate the Org-parsed TOC by default.
The advantage of using Hugo-generated TOC is that it does not clutter
the Markdown source.
Though, the advantage of Org-generated TOC is that you get finer
control on:
- Where to include the TOC --- Location of the =#+TOC= keyword in the
Org content.
- How many headlines to include in the TOC --- /Example: =#+TOC:
headlines 2=/ or =:EXPORT_OPTIONS: toc:2=.
- Whether you want to *not* include a headline in the TOC --- Set the
=UNNUMBERED= property of that headline to =t=.
If you'd like to use the Org-generated TOC instead of the
Hugo-generated one, you can do it one of these many ways:
1. The default is to use the Hugo-generated TOC. But that can be
changed by setting =org-hugo-export-with-toc= variable to a non-nil
value, like =t= or =2=.
2. Org-generated TOC can be enabled per-post by either setting
=EXPORT_OPTIONS= subtree property (for subtree-based exports) or
the =OPTIONS= keyword (for file-based exports) to a non-nil value,
like ~toc:t~ or ~toc:2~.
3. Above two options will insert the TOC between the front-matter and
the Markdown content. If you'd like to insert the Org-generated TOC
anywhere else in the post, you can do it using the =#+TOC=
keyword.. Example: =#+TOC: headlines 2=.
See Org manual [[http://orgmode.org/manual/Table-of-contents.html][Table of Contents]] section for more info.
/Note that =ox-hugo= does not support =#+TOC: listings= and =#+TOC:
tables=./
* COMMENT Local Variables :ARCHIVE:
# Local Variables:
# fill-column: 70

128
ox-hugo.el
Unescape View File

@ -461,6 +461,22 @@ Example value: (org)."
:type 'boolean
:safe #'booleanp)
(defcustom org-hugo-export-with-toc nil
"When non-nil, Markdown format TOC will be inserted.
The TOC contains headlines with levels up
to`org-export-headline-levels'. When an integer, include levels
up to N in the toc, this may then be different from
`org-export-headline-levels', but it will not be allowed to be
larger than the number of headline levels. When nil, no table of
contents is made.
This option can also be set with the OPTIONS keyword,
e.g. \"toc:nil\", \"toc:t\" or \"toc:3\"."
:group 'org-export-hugo
:type 'boolean
:safe #'booleanp)
(defcustom org-hugo-default-static-subdirectory-for-externals "ox-hugo"
"Default sub-directory in Hugo static directory for external files.
If the source path for external files does not contain
@ -522,7 +538,7 @@ The auto-copying behavior is disabled if this variable is set to nil."
;; KEY KEYWORD OPTION DEFAULT BEHAVIOR
:options-alist '(;; Variables not setting the front-matter directly
(:with-toc nil "toc" nil) ;No TOC by default
(:with-toc nil "toc" org-hugo-export-with-toc)
(:with-smart-quotes nil "'" nil) ;Don't use smart quotes; that is done automatically by Blackfriday
(:with-special-strings nil "-" nil) ;Don't use special strings for ndash, mdash; that is done automatically by Blackfriday
(:with-sub-superscript nil "^" '{}) ;Require curly braces to be wrapped around text to sub/super-scripted
@ -684,6 +700,66 @@ This function is called in the very end of
This is an internal function."
(advice-remove 'org-babel-exp-code #'org-hugo--org-babel-exp-code))
(defun org-hugo--build-toc (info &optional n keyword local)
"Return table of contents as a string.
INFO is a plist used as a communication channel.
Optional argument N, when non-nil, is a positive integer
specifying the depth of the table.
Optional argument KEYWORD specifies the TOC keyword, if any, from
which the table of contents generation has been initiated.
When optional argument LOCAL is non-nil, build a table of
contents according to the current headline."
(let* ((toc-headline
(unless local
(let ((style (plist-get info :md-headline-style))
(loffset (plist-get info :hugo-level-offset))
(title "Table of Contents"))
(org-hugo--headline-title style 1 loffset title))))
(toc-items
(mapconcat
(lambda (headline)
(let* ((indentation
(make-string
(* 4 (1- (org-export-get-relative-level headline info)))
?\s))
(headline-num-list (org-export-get-headline-number headline info))
(number (when headline-num-list
;; (message "[ox-hugo TOC DBG] headline-num-list: %S" headline-num-list)
(format "%d." (org-last headline-num-list))))
(bullet (when number
(concat number (make-string (- 4 (length number)) ?\s))))
(title (org-export-data (org-element-property :title headline) info))
(toc-entry
(format "[%s](#%s)"
(org-export-data-with-backend
(org-export-get-alt-title headline info)
(org-export-toc-entry-backend 'hugo)
info)
(or (org-element-property :CUSTOM_ID headline)
(org-hugo-slug title)
;; (org-export-get-reference headline info)
)))
(tags (and (plist-get info :with-tags)
(not (eq 'not-in-toc (plist-get info :with-tags)))
(let ((tags (org-export-get-tags headline info)))
(and tags
(format ":%s:"
(mapconcat #'identity tags ":")))))))
(when bullet
(concat indentation bullet toc-entry tags))))
(org-export-collect-headlines info n (and local keyword))
"\n")) ;Newline between TOC items
;; Remove blank lines from in-between TOC items, which can
;; get introduced when using the "UNNUMBERED: t" headline
;; property.
(toc-items (replace-regexp-in-string "\n\\{2,\\}" "\n" toc-items)))
(concat toc-headline
toc-items
"\n"))) ;Final newline at the end of TOC
;;; Transcode Functions
@ -778,7 +854,7 @@ a communication channel."
(loffset (plist-get info :hugo-level-offset))
(todo (when todo
(concat (org-html--todo todo info) " "))))
(concat (org-hugo--headline-title style level loffset todo title anchor)
(concat (org-hugo--headline-title style level loffset title todo anchor)
contents)))))))
;;;;; Headline Helpers
@ -830,13 +906,18 @@ returned slug string has the following specification:
(str (replace-regexp-in-string "\\(^[-]*\\|[-]*$\\)" "" str)))
str))
(defun org-hugo--headline-title (style level loffset todo title &optional anchor)
(defun org-hugo--headline-title (style level loffset title &optional todo anchor)
"Generate a headline title in the preferred Markdown headline style.
STYLE is the preferred style (`atx' or `setext'). LEVEL is the
header level. LOFFSET is the offset (a non-negative number) that
is added to the Markdown heading level for `atx' style. TODO is
the Org TODO string. TITLE is the headline title. ANCHOR is the
Hugo anchor tag for the section as a string."
STYLE is the preferred style (`atx' or `setext').
LEVEL is the header level.
LOFFSET is the offset (a non-negative number) that is added to the
Markdown heading level for `atx' style.
TITLE is the headline title.
Optional argument TODO is the Org TODO string.
Optional argument ANCHOR is the Hugo anchor tag for the section as a
string."
;; Use "Setext" style
(if (and (eq style 'setext) (< level 3))
(let* ((underline-char (if (= level 1) ?= ?-))
@ -856,10 +937,23 @@ Hugo anchor tag for the section as a string."
"Return body of document after converting it to Hugo-compatible Markdown.
CONTENTS is the transcoded contents string. INFO is a plist
holding export options."
(org-trim (concat
contents
"\n"
(org-blackfriday-footnote-section info))))
(let* ((toc-level (plist-get info :with-toc))
(toc-level (if (and toc-level
(not (wholenump toc-level)))
(plist-get info :headline-levels)
toc-level))
(toc (if (and toc-level
(wholenump toc-level)
(> toc-level 0)) ;TOC will be exported only if toc-level is positive
(concat (org-hugo--build-toc info toc-level) "\n")
"")))
(org-trim (concat
toc
contents
;; Make sure CONTENTS is separated from table of contents
;; and footnotes with at least a blank line.
"\n"
(org-blackfriday-footnote-section info)))))
;;;; Keyword
(defun org-hugo-keyword (keyword contents info)
@ -874,6 +968,15 @@ channel."
(string-match-p "\\`\\s-*more\\s-*\\'" value))
;; https://gohugo.io/content-management/summaries#user-defined-manual-summary-splitting
"<!--more-->")
((and (equal "TOC" kwd)
(string-match-p "\\<headlines\\>" value))
(let ((depth (and (string-match "\\<[0-9]+\\>" value)
(string-to-number (match-string 0 value))))
(local? (string-match-p "\\<local\\>" value)))
(when (and depth
(> depth 0))
(org-remove-indentation
(org-hugo--build-toc info depth keyword local?)))))
(t
(org-md-keyword keyword contents info)))))
@ -2114,6 +2217,7 @@ buffer and returned as a string in Org format."
,(format "|org-hugo-allow-spaces-in-tags |%S|" org-hugo-allow-spaces-in-tags)
,(format "|org-hugo-langs-no-descr-in-code-fences |%S|" org-hugo-langs-no-descr-in-code-fences)
,(format "|org-hugo-auto-set-lastmod |%S|" org-hugo-auto-set-lastmod)
,(format "|org-hugo-export-with-toc |%S|" org-hugo-export-with-toc)
,(format "|org-hugo-front-matter-format |%S|" org-hugo-front-matter-format)
,(format "|org-hugo-default-static-subdirectory-for-externals |%S|" org-hugo-default-static-subdirectory-for-externals)
,(format "|org-hugo-external-file-extensions-allowed-for-copying |%S|" org-hugo-external-file-extensions-allowed-for-copying)

74
test/site/content-org/all-posts.org
Unescape View File

@ -1873,6 +1873,80 @@ This post should be created in =content/section-a/=.
:EXPORT_FILE_NAME: post-ax
:END:
This post should also be created in =content/section-a/=.
* Table of Contents (TOC) :toc:
=ox-hugo= has the =with-toc= option disabled by default as Hugo has an
inbuilt TOC generation feature.
Still some people might prefer to use the Org generated TOC.
** Example post for TOC tests :noexport:
:PROPERTIES:
:CUSTOM_ID: toc-example-post
:END:
*** Post sub-heading 1
**** Post sub-heading 1.1
***** Post sub-heading 1.1.1
**** Post sub-heading 1.2
**** Post sub-heading 1.3
*** Post sub-heading 2
**** Post sub-heading 2.1
**** Post sub-heading 2.2
***** Post sub-heading 2.2.1
***** Post sub-heading 2.2.2
:PROPERTIES:
:UNNUMBERED: t
:END:
The =UNNUMBERED= property for this subtree is set to =t=. So even when
the TOC export option is set to =t= or a number ≥ 3, this title will
*not* show up in the TOC. That's because the TOC is exported as a
Markdown /ordered list/, and you cannot have ordered list items
without a number prefix!
***** Post sub-heading 2.2.3
*** Post sub-heading 3
**** Post sub-heading 3.1
** TOC set using export option :export_option:
*** Post with TOC export option set to non-nil
:PROPERTIES:
:EXPORT_FILE_NAME: post-with-toc-export-option-t
:EXPORT_OPTIONS: toc:t
:END:
#+INCLUDE: "./all-posts.org::#toc-example-post" :only-contents t
*** Post with TOC export option set to 2
:PROPERTIES:
:EXPORT_FILE_NAME: post-with-toc-export-option-2
:EXPORT_OPTIONS: toc:2
:END:
#+INCLUDE: "./all-posts.org::#toc-example-post" :only-contents t
*** Post with TOC export option set to nil
:PROPERTIES:
:EXPORT_FILE_NAME: post-with-toc-export-option-nil
:EXPORT_OPTIONS: toc:nil
:END:
#+INCLUDE: "./all-posts.org::#toc-example-post" :only-contents t
*** Post with TOC export option set to 0
:PROPERTIES:
:EXPORT_FILE_NAME: post-with-toc-export-option-0
:EXPORT_OPTIONS: toc:0
:END:
#+INCLUDE: "./all-posts.org::#toc-example-post" :only-contents t
** TOC set using keyword :keyword:
*** Post with TOC using keyword set to 0
:PROPERTIES:
:EXPORT_FILE_NAME: post-with-toc-keyword-0
:END:
#+TOC: headlines 0
#+INCLUDE: "./all-posts.org::#toc-example-post" :only-contents t
*** Post with TOC using keyword set to 2
:PROPERTIES:
:EXPORT_FILE_NAME: post-with-toc-keyword-2
:END:
#+TOC: headlines 2
#+INCLUDE: "./all-posts.org::#toc-example-post" :only-contents t
*** Post with TOC using keyword set to 6
:PROPERTIES:
:EXPORT_FILE_NAME: post-with-toc-keyword-6
:END:
#+TOC: headlines 6
#+INCLUDE: "./all-posts.org::#toc-example-post" :only-contents t
* TODO Pre-Draft State
:PROPERTIES:
:EXPORT_FILE_NAME: draft-state-todo

49
test/site/content/posts/post-with-toc-export-option-0.md
Unescape View File

@ -0,0 +1,49 @@
+++
title = "Post with TOC export option set to 0"
tags = ["toc", "export-option"]
draft = false
+++
## Post sub-heading 1 {#post-sub-heading-1}
### Post sub-heading 1.1 {#post-sub-heading-1-dot-1}
#### Post sub-heading 1.1.1 {#post-sub-heading-1-dot-1-dot-1}
### Post sub-heading 1.2 {#post-sub-heading-1-dot-2}
### Post sub-heading 1.3 {#post-sub-heading-1-dot-3}
## Post sub-heading 2 {#post-sub-heading-2}
### Post sub-heading 2.1 {#post-sub-heading-2-dot-1}
### Post sub-heading 2.2 {#post-sub-heading-2-dot-2}
#### Post sub-heading 2.2.1 {#post-sub-heading-2-dot-2-dot-1}
#### Post sub-heading 2.2.2 {#post-sub-heading-2-dot-2-dot-2}
The `UNNUMBERED` property for this subtree is set to `t`. So even when
the TOC export option is set to `t` or a number ≥ 3, this title will
**not** show up in the TOC. That's because the TOC is exported as a
Markdown _ordered list_, and you cannot have ordered list items
without a number prefix!
#### Post sub-heading 2.2.3 {#post-sub-heading-2-dot-2-dot-3}
## Post sub-heading 3 {#post-sub-heading-3}
### Post sub-heading 3.1 {#post-sub-heading-3-dot-1}

62
test/site/content/posts/post-with-toc-export-option-2.md
Unescape View File

@ -0,0 +1,62 @@
+++
title = "Post with TOC export option set to 2"
tags = ["toc", "export-option"]
draft = false
+++
## Table of Contents
1. [Post sub-heading 1](#post-sub-heading-1)
1. [Post sub-heading 1.1](#post-sub-heading-1-dot-1)
2. [Post sub-heading 1.2](#post-sub-heading-1-dot-2)
3. [Post sub-heading 1.3](#post-sub-heading-1-dot-3)
2. [Post sub-heading 2](#post-sub-heading-2)
1. [Post sub-heading 2.1](#post-sub-heading-2-dot-1)
2. [Post sub-heading 2.2](#post-sub-heading-2-dot-2)
3. [Post sub-heading 3](#post-sub-heading-3)
1. [Post sub-heading 3.1](#post-sub-heading-3-dot-1)
## Post sub-heading 1 {#post-sub-heading-1}
### Post sub-heading 1.1 {#post-sub-heading-1-dot-1}
#### Post sub-heading 1.1.1 {#post-sub-heading-1-dot-1-dot-1}
### Post sub-heading 1.2 {#post-sub-heading-1-dot-2}
### Post sub-heading 1.3 {#post-sub-heading-1-dot-3}
## Post sub-heading 2 {#post-sub-heading-2}
### Post sub-heading 2.1 {#post-sub-heading-2-dot-1}
### Post sub-heading 2.2 {#post-sub-heading-2-dot-2}
#### Post sub-heading 2.2.1 {#post-sub-heading-2-dot-2-dot-1}
#### Post sub-heading 2.2.2 {#post-sub-heading-2-dot-2-dot-2}
The `UNNUMBERED` property for this subtree is set to `t`. So even when
the TOC export option is set to `t` or a number ≥ 3, this title will
**not** show up in the TOC. That's because the TOC is exported as a
Markdown _ordered list_, and you cannot have ordered list items
without a number prefix!
#### Post sub-heading 2.2.3 {#post-sub-heading-2-dot-2-dot-3}
## Post sub-heading 3 {#post-sub-heading-3}
### Post sub-heading 3.1 {#post-sub-heading-3-dot-1}

49
test/site/content/posts/post-with-toc-export-option-nil.md
Unescape View File

@ -0,0 +1,49 @@
+++
title = "Post with TOC export option set to nil"
tags = ["toc", "export-option"]
draft = false
+++
## Post sub-heading 1 {#post-sub-heading-1}
### Post sub-heading 1.1 {#post-sub-heading-1-dot-1}
#### Post sub-heading 1.1.1 {#post-sub-heading-1-dot-1-dot-1}
### Post sub-heading 1.2 {#post-sub-heading-1-dot-2}
### Post sub-heading 1.3 {#post-sub-heading-1-dot-3}
## Post sub-heading 2 {#post-sub-heading-2}
### Post sub-heading 2.1 {#post-sub-heading-2-dot-1}
### Post sub-heading 2.2 {#post-sub-heading-2-dot-2}
#### Post sub-heading 2.2.1 {#post-sub-heading-2-dot-2-dot-1}
#### Post sub-heading 2.2.2 {#post-sub-heading-2-dot-2-dot-2}
The `UNNUMBERED` property for this subtree is set to `t`. So even when
the TOC export option is set to `t` or a number ≥ 3, this title will
**not** show up in the TOC. That's because the TOC is exported as a
Markdown _ordered list_, and you cannot have ordered list items
without a number prefix!
#### Post sub-heading 2.2.3 {#post-sub-heading-2-dot-2-dot-3}
## Post sub-heading 3 {#post-sub-heading-3}
### Post sub-heading 3.1 {#post-sub-heading-3-dot-1}

65
test/site/content/posts/post-with-toc-export-option-t.md
Unescape View File

@ -0,0 +1,65 @@
+++
title = "Post with TOC export option set to non-nil"
tags = ["toc", "export-option"]
draft = false
+++
## Table of Contents
1. [Post sub-heading 1](#post-sub-heading-1)
1. [Post sub-heading 1.1](#post-sub-heading-1-dot-1)
1. [Post sub-heading 1.1.1](#post-sub-heading-1-dot-1-dot-1)
2. [Post sub-heading 1.2](#post-sub-heading-1-dot-2)
3. [Post sub-heading 1.3](#post-sub-heading-1-dot-3)
2. [Post sub-heading 2](#post-sub-heading-2)
1. [Post sub-heading 2.1](#post-sub-heading-2-dot-1)
2. [Post sub-heading 2.2](#post-sub-heading-2-dot-2)
1. [Post sub-heading 2.2.1](#post-sub-heading-2-dot-2-dot-1)
2. [Post sub-heading 2.2.3](#post-sub-heading-2-dot-2-dot-3)
3. [Post sub-heading 3](#post-sub-heading-3)
1. [Post sub-heading 3.1](#post-sub-heading-3-dot-1)
## Post sub-heading 1 {#post-sub-heading-1}
### Post sub-heading 1.1 {#post-sub-heading-1-dot-1}
#### Post sub-heading 1.1.1 {#post-sub-heading-1-dot-1-dot-1}
### Post sub-heading 1.2 {#post-sub-heading-1-dot-2}
### Post sub-heading 1.3 {#post-sub-heading-1-dot-3}
## Post sub-heading 2 {#post-sub-heading-2}
### Post sub-heading 2.1 {#post-sub-heading-2-dot-1}
### Post sub-heading 2.2 {#post-sub-heading-2-dot-2}
#### Post sub-heading 2.2.1 {#post-sub-heading-2-dot-2-dot-1}
#### Post sub-heading 2.2.2 {#post-sub-heading-2-dot-2-dot-2}
The `UNNUMBERED` property for this subtree is set to `t`. So even when
the TOC export option is set to `t` or a number ≥ 3, this title will
**not** show up in the TOC. That's because the TOC is exported as a
Markdown _ordered list_, and you cannot have ordered list items
without a number prefix!
#### Post sub-heading 2.2.3 {#post-sub-heading-2-dot-2-dot-3}
## Post sub-heading 3 {#post-sub-heading-3}
### Post sub-heading 3.1 {#post-sub-heading-3-dot-1}

49
test/site/content/posts/post-with-toc-keyword-0.md
Unescape View File

@ -0,0 +1,49 @@
+++
title = "Post with TOC using keyword set to 0"
tags = ["toc", "keyword"]
draft = false
+++
## Post sub-heading 1 {#post-sub-heading-1}
### Post sub-heading 1.1 {#post-sub-heading-1-dot-1}
#### Post sub-heading 1.1.1 {#post-sub-heading-1-dot-1-dot-1}
### Post sub-heading 1.2 {#post-sub-heading-1-dot-2}
### Post sub-heading 1.3 {#post-sub-heading-1-dot-3}
## Post sub-heading 2 {#post-sub-heading-2}
### Post sub-heading 2.1 {#post-sub-heading-2-dot-1}
### Post sub-heading 2.2 {#post-sub-heading-2-dot-2}
#### Post sub-heading 2.2.1 {#post-sub-heading-2-dot-2-dot-1}
#### Post sub-heading 2.2.2 {#post-sub-heading-2-dot-2-dot-2}
The `UNNUMBERED` property for this subtree is set to `t`. So even when
the TOC export option is set to `t` or a number ≥ 3, this title will
**not** show up in the TOC. That's because the TOC is exported as a
Markdown _ordered list_, and you cannot have ordered list items
without a number prefix!
#### Post sub-heading 2.2.3 {#post-sub-heading-2-dot-2-dot-3}
## Post sub-heading 3 {#post-sub-heading-3}
### Post sub-heading 3.1 {#post-sub-heading-3-dot-1}

62
test/site/content/posts/post-with-toc-keyword-2.md
Unescape View File

@ -0,0 +1,62 @@
+++
title = "Post with TOC using keyword set to 2"
tags = ["toc", "keyword"]
draft = false
+++
## Table of Contents
1. [Post sub-heading 1](#post-sub-heading-1)
1. [Post sub-heading 1.1](#post-sub-heading-1-dot-1)
2. [Post sub-heading 1.2](#post-sub-heading-1-dot-2)
3. [Post sub-heading 1.3](#post-sub-heading-1-dot-3)
2. [Post sub-heading 2](#post-sub-heading-2)
1. [Post sub-heading 2.1](#post-sub-heading-2-dot-1)
2. [Post sub-heading 2.2](#post-sub-heading-2-dot-2)
3. [Post sub-heading 3](#post-sub-heading-3)
1. [Post sub-heading 3.1](#post-sub-heading-3-dot-1)
## Post sub-heading 1 {#post-sub-heading-1}
### Post sub-heading 1.1 {#post-sub-heading-1-dot-1}
#### Post sub-heading 1.1.1 {#post-sub-heading-1-dot-1-dot-1}
### Post sub-heading 1.2 {#post-sub-heading-1-dot-2}
### Post sub-heading 1.3 {#post-sub-heading-1-dot-3}
## Post sub-heading 2 {#post-sub-heading-2}
### Post sub-heading 2.1 {#post-sub-heading-2-dot-1}
### Post sub-heading 2.2 {#post-sub-heading-2-dot-2}
#### Post sub-heading 2.2.1 {#post-sub-heading-2-dot-2-dot-1}
#### Post sub-heading 2.2.2 {#post-sub-heading-2-dot-2-dot-2}
The `UNNUMBERED` property for this subtree is set to `t`. So even when
the TOC export option is set to `t` or a number ≥ 3, this title will
**not** show up in the TOC. That's because the TOC is exported as a
Markdown _ordered list_, and you cannot have ordered list items
without a number prefix!
#### Post sub-heading 2.2.3 {#post-sub-heading-2-dot-2-dot-3}
## Post sub-heading 3 {#post-sub-heading-3}
### Post sub-heading 3.1 {#post-sub-heading-3-dot-1}

65
test/site/content/posts/post-with-toc-keyword-6.md
Unescape View File

@ -0,0 +1,65 @@
+++
title = "Post with TOC using keyword set to 6"
tags = ["toc", "keyword"]
draft = false
+++
## Table of Contents
1. [Post sub-heading 1](#post-sub-heading-1)
1. [Post sub-heading 1.1](#post-sub-heading-1-dot-1)
1. [Post sub-heading 1.1.1](#post-sub-heading-1-dot-1-dot-1)
2. [Post sub-heading 1.2](#post-sub-heading-1-dot-2)
3. [Post sub-heading 1.3](#post-sub-heading-1-dot-3)
2. [Post sub-heading 2](#post-sub-heading-2)
1. [Post sub-heading 2.1](#post-sub-heading-2-dot-1)
2. [Post sub-heading 2.2](#post-sub-heading-2-dot-2)
1. [Post sub-heading 2.2.1](#post-sub-heading-2-dot-2-dot-1)
2. [Post sub-heading 2.2.3](#post-sub-heading-2-dot-2-dot-3)
3. [Post sub-heading 3](#post-sub-heading-3)
1. [Post sub-heading 3.1](#post-sub-heading-3-dot-1)
## Post sub-heading 1 {#post-sub-heading-1}
### Post sub-heading 1.1 {#post-sub-heading-1-dot-1}
#### Post sub-heading 1.1.1 {#post-sub-heading-1-dot-1-dot-1}
### Post sub-heading 1.2 {#post-sub-heading-1-dot-2}
### Post sub-heading 1.3 {#post-sub-heading-1-dot-3}
## Post sub-heading 2 {#post-sub-heading-2}
### Post sub-heading 2.1 {#post-sub-heading-2-dot-1}
### Post sub-heading 2.2 {#post-sub-heading-2-dot-2}
#### Post sub-heading 2.2.1 {#post-sub-heading-2-dot-2-dot-1}
#### Post sub-heading 2.2.2 {#post-sub-heading-2-dot-2-dot-2}
The `UNNUMBERED` property for this subtree is set to `t`. So even when
the TOC export option is set to `t` or a number ≥ 3, this title will
**not** show up in the TOC. That's because the TOC is exported as a
Markdown _ordered list_, and you cannot have ordered list items
without a number prefix!
#### Post sub-heading 2.2.3 {#post-sub-heading-2-dot-2-dot-3}
## Post sub-heading 3 {#post-sub-heading-3}
### Post sub-heading 3.1 {#post-sub-heading-3-dot-1}
Write Preview
Loading…
Cancel
Save