Skip to content

Commit 0d9d02d

Browse files
jebeckkenwheeler
authored andcommitted
add warning re: deployment to GitHub Pages and dist dir path (#334)
* add warning re: deployment to GitHub Pages and dist dir path * oops, typo in link alt text
1 parent 8a4cebf commit 0d9d02d

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.markdown

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,8 @@ Building the dist version of the project is as easy as running `npm run build`
7979

8080
If you want to deploy the slideshow to surge, run `npm run deploy`
8181

82+
<span role="img" aria-label="Warning Sign">⚠️</span> If you are deploying the dist version to [GitHub Pages](https://pages.github.com/ 'GitHub Pages'), note that the built bundle uses an absolute path to the `/dist/` directory while GitHub Pages requires the relative `./dist/` to find any embedded assets and/or images. A very hacky way to fix this is to edit one place in the produced bundle, as shown [in this GitHub issue](https://github.com/FormidableLabs/spectacle/issues/326#issue-233283633 'GitHub: spectacle issue #326').
83+
8284
<a name="presenting"></a>
8385
## Presenting
8486

0 commit comments

Comments
 (0)