Skip to content

v1.0.0

Latest
Compare
Choose a tag to compare
@IanWold IanWold released this 01 Nov 19:56
· 16 commits to main since this release
6632abd

First release!

Setup

  1. Fork this repo
  2. On your new repository, go to Settings > Actions (under Code and Automation) > General, and in the section Workflow permissions:
    1. Select Read and Write Permissions
    2. Check Allow GitHub Actions to create and approve pull requests
    3. Click Save
  3. Add an RSS feed to Feeds in config.json and commit it to test that the build works. RSS implementations can vary widely, and sometimes RSS files can be invalid. I like testing with https://gizmodo.com/feed because I know it's always well-formed. If the build worked, there should now be a gh-pages branch in your repository!
  4. On your repositor, go to Settings > Pages (Under Code and Automation), and in the Build and Deployment section:
    1. Set Source to Deploy from a branch
    2. Select gh-pages as the Branch
    3. Click Save
  5. Your site should deploy in a few seconds to a default URL. Navigate to this URL to ensure it deployed correctly.
  6. You're done! Add all the RSS feeds you want, though be careful that invalid RSS files can cause the build to fail. Continue on this README for all the options you have for configuration, and then when you're happy share your blogroll with the world!