feat: allow specifying export filename in the frontmatter (#547)

slidevjs · Apr 14, 2022 · 415aaae · 415aaae
1 parent df066d4
commit 415aaae
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 5 deletions.
diff --git a/packages/client/logic/nav.ts b/packages/client/logic/nav.ts
@@ -158,7 +158,9 @@ export async function downloadPDF() {
   saveAs(
     isString(configs.download)
       ? configs.download
-      : `${import.meta.env.BASE_URL}slidev-exported.pdf`,
+      : configs.exportFilename
+        ? `${configs.exportFilename}.pdf`
+        : `${import.meta.env.BASE_URL}slidev-exported.pdf`,
     `${configs.title}.pdf`,
   )
 }

diff --git a/packages/parser/src/config.ts b/packages/parser/src/config.ts
@@ -20,6 +20,7 @@ export function resolveConfig(headmatter: any, themeMeta: SlidevThemeMeta = {})
     routerMode: 'history',
     aspectRatio: 16 / 9,
     canvasWidth: 980,
+    exportFilename: '',
     selectable: false,
     themeConfig: {},
     fonts: {} as ResolvedFontOptions,
@@ -37,7 +38,7 @@ export function resolveConfig(headmatter: any, themeMeta: SlidevThemeMeta = {})
       ...headmatter.config?.fonts,
       ...headmatter?.fonts,
     }),
-    drawings: resolveDarwings(headmatter.drawings),
+    drawings: resolveDrawings(headmatter.drawings),
   }
 
   if (config.colorSchema !== 'dark' && config.colorSchema !== 'light')
@@ -135,7 +136,7 @@ export function resolveFonts(fonts: FontOptions = {}): ResolvedFontOptions {
   }
 }
 
-function resolveDarwings(options: DrawingsOptions = {}): ResolvedDrawingsOptions {
+function resolveDrawings(options: DrawingsOptions = {}): ResolvedDrawingsOptions {
   const {
     enabled = true,
     persist = false,

diff --git a/packages/slidev/node/build.ts b/packages/slidev/node/build.ts
@@ -89,6 +89,7 @@ export async function build(
   }
 
   const outDir = resolve(options.userRoot, config.build.outDir)
+  const outFilename = options.data.config.exportFilename || 'slidev-exported.pdf'
 
   // copy index.html to 404.html for GitHub Pages
   await fs.copyFile(resolve(outDir, 'index.html'), resolve(outDir, '404.html'))
@@ -116,7 +117,7 @@ export async function build(
       port,
       total: options.data.slides.length,
       format: 'pdf',
-      output: join(outDir, 'slidev-exported.pdf'),
+      output: join(outDir, outFilename),
       base: config.base,
       dark: options.data.config.colorSchema === 'dark',
       width: 1920,

diff --git a/packages/slidev/node/cli.ts b/packages/slidev/node/cli.ts
@@ -334,11 +334,11 @@ cli.command(
     dark,
     'with-clicks': withClicks,
   }) => {
-    output = output || `${path.basename(entry, '.md')}-export`
     process.env.NODE_ENV = 'production'
     const { exportSlides } = await import('./export')
     const port = await findFreePort(12445)
     const options = await resolveOptions({ entry, theme }, 'build')
+    output = output || options.data.config.exportFilename || `${path.basename(entry, '.md')}-export`
     const server = await createServer(
       options,
       {

diff --git a/packages/types/src/config.ts b/packages/types/src/config.ts
@@ -79,6 +79,11 @@ export interface SlidevConfig {
    * @default '980'
    */
   canvasWidth: number
+  /**
+   * Force the filename used when exporting the presentation.
+   * The extension, e.g. .pdf, gets automatically added.
+   */
+  exportFilename: string | null
   /**
    * Controls whether texts in slides are selectable
    *

diff --git a/test/__snapshots__/parser.test.ts.snap b/test/__snapshots__/parser.test.ts.snap
@@ -12,6 +12,7 @@ exports[`md parser > frontmatter.md > config 1`] = `
     "presenterOnly": false,
     "syncAll": true,
   },
+  "exportFilename": "",
   "favicon": "https://cdn.jsdelivr.net/gh/slidevjs/slidev/assets/favicon.png",
   "fonts": {
     "italic": false,
@@ -240,6 +241,7 @@ exports[`md parser > minimal.md > config 1`] = `
     "presenterOnly": false,
     "syncAll": true,
   },
+  "exportFilename": "",
   "favicon": "https://cdn.jsdelivr.net/gh/slidevjs/slidev/assets/favicon.png",
   "fonts": {
     "italic": false,
@@ -406,6 +408,7 @@ exports[`md parser > multi-entries.md > config 1`] = `
     "presenterOnly": false,
     "syncAll": true,
   },
+  "exportFilename": "",
   "favicon": "https://cdn.jsdelivr.net/gh/slidevjs/slidev/assets/favicon.png",
   "fonts": {
     "italic": false,