Tina GitHub Pages Starter

A starter template for using TinaCMS with GitHub Pages (using Jekyll).

Using this starter

1. Select Use this template > Create a new repository.
   • Name the repo <YOUR-GITHUB-USERNAME>.github.io.
   • Select Include all branches.
2. Wait for gh-pages to initialize.
   • Go to Settings > Pages and copy the site URL.
3. Log in to Tina.
   • Select New Project > Import your Site.
   • Authenticate with GitHub and select your project repo.
   • Under "Site URL(s)", enter your GitHub Pages site URL.
   • Note the Client ID.
4. Select Tokens > New Token.
   • Name the token.
   • Under Git Branches, enter main.
   • Create Token. Note the Token string.
5. Back on GitHub, go to Settings > Secrets and variables > Actions > new repository secret. Do this twice:
   • Name: CLIENT_ID, and paste the Client ID.
   • Name: READ_TOKEN, and paste the Token string.
6. In your code, navigate to .github/workflows/deploy.yml. Delete the # from line 7 to uncomment it. Commit changes.
7. Your site should start recompiling: first on main, then on gh-pages.
8. Once complete, navigate to https://<YOUR SITE URL>/admin to find your TinaCMS dashboard.

Known Issues

Tina on GitHub Pages

• Doesn't work with project sites, only user sites.
• Errors parsing markdown: almost always have to edit content in raw-mode.

Template

• Missing instructions on local development, i.e. dependencies and setup.
• Missing instructions on changing Jekyll theme, and tips for further customization.

Contributing

Pull requests, issues, and feedback are all more than welcome!

Acknowledgements

• This starter template by Scott Lee Chua.
• Many thanks to Huw Fulcher for their blog post "How to integrate TinaCMS with Jekyll", without which this template would not exist.
• Thanks to Parker Moore and the contributors to Minima, the Jekyll default theme.