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

Github Pages #15

Open
thibaultmol opened this issue Jul 8, 2021 · 3 comments
Open

Github Pages #15

thibaultmol opened this issue Jul 8, 2021 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@thibaultmol
Copy link

Maybe this is a dumb question. But is it not possible to use Suri with Github pages instead?

@jstayton
Copy link
Owner

jstayton commented Jul 8, 2021

Hey Thibault,

Yes, totally. You can use Suri anywhere you can deploy a static site, so GitHub Pages fits the bill.

While it's not based on Jekyll – and so won't be built automatically by GitHub – you should be able to use Actions to automate that. Or, of course, you can just build locally on your machine and push the generated static site up to your GitHub Pages branch.

I'm going to leave this open because I do want to add documentation about GitHub Pages to the README when I get a chance. Feel free to post back here with anything you find along the way as well!

@jstayton jstayton added the documentation Improvements or additions to documentation label Jul 8, 2021
@shirgoldbird
Copy link

This is exactly what I wanted to do. After some research I have it set up and working perfectly. This project is AMAZING. Thank you @jstayton :)

I followed this guide for deploying Eleventy with GH Actions and made two changes.

  1. Instead of creating a new SSH key, I used a GH token like so and then followed these instructions: github_token: ${{ secrets.GITHUB_TOKEN }}
  2. I changed the directory to build from to _site: publish_dir: ./_site

@shirgoldbird
Copy link

One more change needed if you want to use a custom domain:

  1. Add a CNAME file that contains your custom domain to the public folder.

Otherwise your custom domain will be removed on every build (oops)

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

No branches or pull requests

3 participants