d2l-book
d2l-book copied to clipboard
Missing important step in github pages deployment
When deploying the generated html to github, it will be treated as a jekyll website thus the content won't be rendering correctly. Namely, in this case, the html pages won't be able to load static files like css and images which leads to having a broken page.
A quick fix is to add an empty file named .nojekyll
to the root of the html folder.
Since this is essential to have correct display, we can:
- Automatically add this file
.nojekyll
whend2lbook deploy html
is run - Or instruct the user to add in the documentation.
Here's an example deployment I did on github with the above tip
- https://github.com/mohamed-ali/d2l-ar-demo
- https://mohamed-ali.github.io/d2l-ar-demo/