feat: add --without-notes option for build (#2387)

Author: serkodev

docs/builtin/cli.md

@@ -59,6 +59,7 @@ Options:
 - `--base` (`string`, default: `/`): base URL (see https://vitejs.dev/config/shared-options.html#base)
 - `--download` (`boolean`, default: `false`): allow the download of the slides as a PDF inside the SPA
 - `--theme`, `-t` (`string`): override theme
+- `--without-notes` (`boolean`, default: `false`): exclude speaker notes from the SPA
 
 ## `slidev export [...entry]` {#export}
 

docs/guide/hosting.md

@@ -34,6 +34,14 @@ You can change the output directory using `--out`.
 $ slidev build --out my-build-folder
 ```
 
+### Remove speaker notes {#without-notes}
+
+If you are sharing the built slides publicly and don't want to include your speaker notes, run the build with `--without-notes`:
+
+```bash
+$ slidev build --without-notes
+```
+
 ### Multiple Builds {#multiple-builds}
 
 You can build multiple slide decks in one go by passing multiple markdown files as arguments:

packages/slidev/node/cli.ts

@@ -347,6 +347,10 @@ cli.command(
       type: 'boolean',
       describe: 'allow download as PDF',
     })
+    .option('without-notes', {
+      type: 'boolean',
+      describe: 'exclude speaker notes from the built output',
+    })
     .option('inspect', {
       default: false,
       type: 'boolean',
@@ -355,11 +359,11 @@ cli.command(
     .strict()
     .help(),
   async (args) => {
-    const { entry, theme, base, download, out, inspect } = args
+    const { entry, theme, base, download, out, inspect, 'without-notes': withoutNotes } = args
     const { build } = await import('./commands/build')
 
     for (const entryFile of entry as unknown as string[]) {
-      const options = await resolveOptions({ entry: entryFile, theme, inspect, download, base }, 'build')
+      const options = await resolveOptions({ entry: entryFile, theme, inspect, download, base, withoutNotes }, 'build')
 
       printInfo(options)
       await build(

packages/slidev/node/vite/loaders.ts

@@ -22,7 +22,7 @@ export function createSlidesLoader(
   options: ResolvedSlidevOptions,
   serverOptions: SlidevServerOptions,
 ): Plugin {
-  const { data, mode, utils } = options
+  const { data, mode, utils, withoutNotes } = options
 
   const notesMd = MarkdownIt({ html: true })
   notesMd.use(markdownItLink)
@@ -363,6 +363,9 @@ export function createSlidesLoader(
   }
 
   function renderNote(text: string = '') {
+    if (withoutNotes)
+      return ''
+
     let clickCount = 0
     const notesAutoRuby: Record<string, string | undefined> = (data.headmatter as any).notesAutoRuby || {}
 
@@ -399,6 +402,7 @@ export function createSlidesLoader(
   function withRenderedNote(data: SlideInfo): SlideInfo {
     return {
       ...data,
+      ...withoutNotes && { note: '' },
       noteHTML: renderNote(data?.note),
     }
   }

packages/types/src/cli.ts

@@ -20,8 +20,9 @@ export interface ExportArgs extends CommonArgs {
 }
 
 export interface BuildArgs extends ExportArgs {
-  out: string
-  base?: string
-  download?: boolean
-  inspect: boolean
+  'out': string
+  'base'?: string
+  'download'?: boolean
+  'inspect': boolean
+  'without-notes'?: boolean
 }

packages/types/src/options.ts

@@ -41,6 +41,11 @@ export interface SlidevEntryOptions {
    * Base URL in dev or build mode
    */
   base?: string
+
+  /**
+   * Exclude speaker notes from the built output
+   */
+  withoutNotes?: boolean
 }
 
 export interface ResolvedSlidevOptions extends RootsInfo, SlidevEntryOptions {