Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing important step in github pages deployment #22

Open
mohamed-ali opened this issue Dec 29, 2020 · 0 comments
Open

Missing important step in github pages deployment #22

mohamed-ali opened this issue Dec 29, 2020 · 0 comments

Comments

@mohamed-ali
Copy link
Contributor

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 when d2lbook 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant