feat: cli allowDownload

docs/guide/exporting.md

@@ -5,6 +5,7 @@
 Exporting your slides into PDF by the following command
 
 ```bash
+$ npm i -D playwright-chromium
 $ slidev export
 ```
 
@@ -28,10 +29,17 @@ $ slidev build
 
 The dist will be available under `dist/` and then you can host them on [GitHub Pages](https://pages.github.com/), [Netlify](https://netlify.app/), [Vercel](https://vercel.com/), or whatever you want. And share your slides with the world with a single link.
 
-By default, it also generates a pdf file along with the build. And in the SPA, there will be a button for viewers to download the slides as PDF. If you don't want that, you can disable it by:
+### Provide Downloadable PDF
+
+You can provide a downloadable PDF to the viewers of your SPA. You can enable it by the following config:
 
 ```md
 ---
-allow-download: false
+allow-download: true
 ---
 ```
+
+It will generate a pdf file along with the build. And a download button will appear in the SPA.
+
+If you are building it in a CI environment, you might need to have [`playwright-chromium`](https://playwright.dev/docs/installation#download-single-browser-binary) installed as well. Learn more [here](https://playwright.dev/docs/ci)
+

package.json

@@ -28,7 +28,7 @@
     "esno": "^0.5.0",
     "execa": "^5.0.0",
     "jest": "^26.6.3",
-    "playwright": "^1.10.0",
+    "playwright-chromium": "^1.10.0",
     "pnpm": "^6.2.2",
     "ts-jest": "^26.5.5",
     "typescript": "^4.2.4",

packages/slidev/node/cli.ts

@@ -105,11 +105,17 @@ cli.command(
       type: 'string',
       describe: 'output base',
     })
+    .option('allowDownload', {
+      alias: 'd',
+      type: 'boolean',
+      describe: 'allow download as PDF',
+    })
     .help(),
-  async({ entry, theme, watch, base }) => {
-    console.log(yellow('  [Slidev] the SPA build is experimental, recommend to use dev server instead at this moment.'))
-
+  async({ entry, theme, watch, base, allowDownload }) => {
     const options = await resolveOptions({ entry, theme }, 'build')
+    if (allowDownload)
+      options.data.config.allowDownload = allowDownload
+
     printInfo(options)
     await build(options, {}, {
       base,

packages/slidev/node/export.ts

@@ -1,10 +1,11 @@
 import path from 'path'
 import fs from 'fs-extra'
-import { chromium } from 'playwright'
+import { chromium } from 'playwright-chromium'
 import { PDFDocument } from 'pdf-lib'
 import { blue, cyan, green, yellow } from 'kolorist'
 import { Presets, SingleBar } from 'cli-progress'
 import { getPagesByRange } from './utils'
+import { packageExists } from './themes'
 
 export interface ExportOptions {
   total: number
@@ -59,6 +60,9 @@ export async function exportSlides({
   output = 'slides',
   timeout = 500,
 }: ExportOptions) {
+  if (!packageExists('playwright-chromium'))
+    throw new Error('The exporting for Slidev is powered by Playwright, please installed it via `npm i playwright-chromium`')
+
   const browser = await chromium.launch()
   const context = await browser.newContext({
     viewport: {

packages/slidev/package.json

@@ -36,10 +36,10 @@
   "homepage": "https://github.com/slidevjs/slidev",
   "bugs": "https://github.com/slidevjs/slidev/issues",
   "peerDependencies": {
-    "playwright": "^1.10.0"
+    "playwright-chromium": "^1.10.0"
   },
   "peerDependenciesMeta": {
-    "playwright": {
+    "playwright-chromium": {
       "optional": true
     }
   },
@@ -93,7 +93,7 @@
     "cross-env": "^7.0.3",
     "eslint": "^7.25.0",
     "esno": "^0.5.0",
-    "playwright": "^1.10.0",
+    "playwright-chromium": "^1.10.0",
     "pnpm": "^6.2.2",
     "rimraf": "^3.0.2",
     "tsup": "^4.10.1",

scripts/docs.ts

@@ -9,12 +9,12 @@ run('mkdir docs/public/demo')
 
 run('npm run build')
 
-run('npx slidev build slides.md --base /demo/composable-vue/', path.resolve(__dirname, '../demo'))
+run('npx slidev build slides.md -d --base /demo/composable-vue/', path.resolve(__dirname, '../demo'))
 run('cp -R demo/dist docs/public/demo/composable-vue')
 
 run('cp packages/create-app/template/slides.md demo/build.md')
 run('cp -R packages/create-app/template/public demo')
-run('npx slidev build build.md --base /demo/starter/', path.resolve(__dirname, '../demo'))
+run('npx slidev build build.md -d --base /demo/starter/', path.resolve(__dirname, '../demo'))
 
 run('cp -R demo/dist docs/public/demo/starter')