add info on base paths

murilo-cunha · Jul 7, 2023 · 01ee05f · 01ee05f
1 parent af98547
commit 01ee05f
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -3,7 +3,7 @@ on:
  push:
  branches: [main]
 env:
- BASE: slidev-addon-asciinema
+ BASE: /slidev-addon-asciinema
 jobs:
  publish:
  runs-on: ubuntu-latest

diff --git a/README.md b/README.md
@@ -106,6 +106,21 @@ All the[ `asciinema-player`'s options](https://github.com/asciinema/asciinema-pl
 </RenderWhen>
 ```
 
+### Base paths
+
+If you are building your slides for [static hosting](https://sli.dev/guide/hosting.html#static-hosting) and you are using a different [base path](https://sli.dev/guide/hosting.html#base-path) (i.e.: you're using GitHub Pages). The component should work as expected, but remember to include the base path in your `vite.config.js` file.
+
+```sh
+slidev build --base /your-base-path
+```
+
+```js
+export default {
+ base: '/your-base-path',
+};
+
+```
+
 ## Known issues
 
 There are a couple of issues already identified