Merge pull request #384 from marp-team/pdf-outlines

Add `markdown.marp.pdf.outlines` option

CHANGELOG.md

@@ -4,10 +4,14 @@
 
 ## [Unreleased]
 
+### Added
+
+- `markdown.marp.pdf.outlines` option to generate outlines in exported PDF ([#381](https://github.com/marp-team/marp-vscode/issues/381), [#384](https://github.com/marp-team/marp-vscode/pull/384))
+
 ### Changed
 
 - Upgrade Marp Core to [v3.3.3](https://github.com/marp-team/marp-core/releases/tag/v3.3.3) ([#378](https://github.com/marp-team/marp-vscode/pull/378))
-- Upgrade Marp CLI to [v2.1.4](https://github.com/marp-team/marp-cli/releases/tag/v2.1.4) ([#380](https://github.com/marp-team/marp-vscode/pull/380))
+- Upgrade Marp CLI to [v2.2.0](https://github.com/marp-team/marp-cli/releases/tag/v2.2.0) ([#384](https://github.com/marp-team/marp-vscode/pull/384))
 
 ## v2.2.1 - 2022-08-12
 

package.json

@@ -172,10 +172,27 @@
           "default": false,
           "markdownDescription": "Adds [presenter notes](https://marpit.marp.app/usage?id=presenter-notes) to exported PDF as note annotations."
         },
+        "markdown.marp.pdf.outlines": {
+          "type": "string",
+          "enum": [
+            "off",
+            "pages",
+            "headings",
+            "both"
+          ],
+          "default": "off",
+          "description": "Adds outlines (bookmarks) to exported PDF. It is useful for navigation in PDF viewer.",
+          "enumDescriptions": [
+            "Disable outlines.",
+            "Add outlines based on each slide page.",
+            "Add outlines based on each Markdown heading.",
+            "Add outlines based on both slide pages and Markdown headings."
+          ]
+        },
         "markdown.marp.strictPathResolutionDuringExport": {
           "type": "boolean",
           "default": false,
-          "markdownDescription": "_[Experimental]_ Enables strict path resolution during export. If enabled, the export command tries to resolve relative paths from VS Code workspace that a Markdown file belongs. If not, or the Markdown does not belong to any workspace, the export command resolves paths based on the local file system."
+          "markdownDescription": "_[Experimental]_ Enables strict path resolution during export. If enabled, the export command tries to resolve relative paths from VS Code workspace that a Markdown file belongs. If disabled, or the Markdown does not belong to any workspace, the export command resolves paths based on the local file system."
         },
         "markdown.marp.themes": {
           "type": "array",
@@ -314,13 +331,14 @@
     "typescript": "^4.7.4",
     "unified": "^10.1.2",
     "unist-util-visit": "^4.1.0",
+    "util": "^0.12.4",
     "vsce": "^2.10.0",
     "vscode-uri": "^3.0.3",
     "webpack": "^5.74.0",
     "webpack-cli": "^4.10.0",
     "yaml": "^2.1.1"
   },
   "dependencies": {
-    "@marp-team/marp-cli": "^2.1.4"
+    "@marp-team/marp-cli": "^2.2.0"
   }
 }

src/__mocks__/vscode.ts

@@ -10,6 +10,7 @@ const defaultConf: MockedConf = {
   'markdown.marp.exportType': 'pdf',
   'markdown.marp.outlineExtension': true,
   'markdown.marp.pdf.noteAnnotations': false,
+  'markdown.marp.pdf.outlines': 'off',
   'window.zoomLevel': 0,
 }