coleslaw-org / coleslaw

Flexible Lisp Blogware
BSD 2-Clause "Simplified" License
562 stars 82 forks source link

How do we deploy to github pages? #211

Closed daninus14 closed 9 months ago

daninus14 commented 9 months ago

How do we deploy to github pages?

The docs mention there's a plugin, but I couldn't find the docs.

Thanks!

daninus14 commented 9 months ago

found it https://github.com/coleslaw-org/coleslaw/blob/master/docs/plugin-use.md

daninus14 commented 9 months ago

Ok, back here. I set up the config file, but when I do deploy, no branch is generated nor pushed. The deploy just generates a deploy/ directory. How do we use the plugin?

daninus14 commented 9 months ago

Here's my config file in case it makes a difference: https://github.com/daninus14/daninus14.github.io/blob/main/.coleslawrc

daninus14 commented 9 months ago

Solution

The deployment works with the usual coleslaw deploy.

Troubleshooting

If you ran deploy once before, that may prevent the github deployment from working.

  1. You should make sure to save the current state of your repository
  2. Delete the deploy/ directory
  3. Try deploying again, this time you should notice that the script is creating a new repository with its own .git directory under deploy, and it should be pushed to gh-pages.
  4. Make sure all the settings in the configuration file are set up correctly.

If anyone reads this, please add it to the docs!

daninus14 commented 9 months ago

Added it as a wiki page...