TOC:

- Indent item based on header level
- Documentation

Author: jessp01

README.md

@@ -16,6 +16,7 @@ This package depends on two other packages:
 - [Syntax highlighting (for code blocks)](#syntax-highlighting)
 - [Dark and light themes](#custom-themes)
 - [Customised themes (by passing a JSON file to `md2pdf`)](#custom-themes)
+- [Auto Generation of Table of Contents]()
 - [Support of non-Latin charsets and multiple fonts](#using-non-ascii-glyphsfonts)
 - [Pagination control (using horizontal lines - especially useful for presentations)](#additional-options)
 - [Page Footer (consisting of author, title and page number)](#additional-options)
@@ -61,6 +62,13 @@ For examples, see [testdata/syntax_highlighting.md](./testdata/syntax_highlighti
 However, if you wish to customise the font faces, sizes and colours, you can use the JSONs in
 [custom_themes](./custom_themes) as a starting point. Edit to your liking and pass `--theme /path/to/json` to `md2pdf`
 
+## Auto Generation of Table of Contents
+
+`md2pdf` can automatically generate a TOC (where each item corresponds to a header in the doc) and include it in the first page.
+These can then be clicked to navigate to the relevant section.
+
+To make use of this feature, simple pass `--generate-toc` as argument.
+
 ## Quick start
 
 ```
@@ -104,6 +112,8 @@ annotation name must match the syntax base filename.*
     	path to font file to use
   -font-name string
     	Font name ID; e.g 'Helvetica-1251'
+  -generate-toc
+    	Auto Generate Table of Contents (TOC)
   -help
     	Show usage message
   -i string

cmd/md2pdf/md2pdf.go

@@ -29,7 +29,7 @@ var fontName = flag.String("font-name", "", "Font name ID; e.g 'Helvetica-1251'"
 var themeArg = flag.String("theme", "light", "[light | dark | /path/to/custom/theme.json]")
 var hrAsNewPage = flag.Bool("new-page-on-hr", false, "Interpret HR as a new page; useful for presentations")
 var printFooter = flag.Bool("with-footer", false, "Print doc footer (<author>  <title>  <page number>)")
-var generateTOC = flag.Bool("generate-toc", false, "Auto Generate TOC")
+var generateTOC = flag.Bool("generate-toc", false, "Auto Generate Table of Contents (TOC)")
 var pageSize = flag.String("page-size", "A4", "[A3 | A4 | A5]")
 var orientation = flag.String("orientation", "portrait", "[portrait | landscape]")
 var logFile = flag.String("log-file", "", "Path to log file")
@@ -203,8 +203,11 @@ func main() {
 			if linkPtr, exists := headerLinks[header.Title]; exists {
 				link := *linkPtr
 				pf.Pdf.SetFont("Arial", "", 12)
+				pf.Pdf.SetTextColor(100, 149, 237)
 				tr := pf.Pdf.UnicodeTranslatorFromDescriptor("")
-				pf.Pdf.WriteLinkID(8, fmt.Sprintf("%s %s", tr("•"), header.Title), link)
+				bulletChar := tr("•")
+				indent := strings.Repeat("  ", header.Level-1)
+				pf.Pdf.WriteLinkID(8, fmt.Sprintf("%s %s %s", indent, bulletChar, header.Title), link)
 				pf.Pdf.Ln(15)
 			}
 		}

md2pdf.1.md

@@ -38,6 +38,13 @@ For examples, see `testdata/Markdown Documentation - Syntax.text` and `testdata/
 However, if you wish to customise the font faces, sizes and colours, you can use the JSONs in
 [custom_themes](./custom_themes) as a starting point. Edit to your liking and pass `--theme /path/to/json` to `md2pdf`
 
+## Auto Generation of Table of Contents
+
+`md2pdf` can automatically generate a TOC (where each item corresponds to a header in the doc) and include it in the first page.
+These can then be clicked to navigate to the relevant section.
+
+To make use of this feature, simple pass `--generate-toc` as argument.
+
 ## Synopsis
 
 ```sh
@@ -47,6 +54,8 @@ However, if you wish to customise the font faces, sizes and colours, you can use
     	path to font file to use
   -font-name string
     	Font name ID; e.g 'Helvetica-1251'
+  -generate-toc
+    	Auto Generate Table of Contents (TOC)
   -help
     	Show usage message
   -i string