https://github.com/scottleechua/tina-ghpages-starter

Starter template for using TinaCMS with GitHub Pages (Jekyll)
https://github.com/scottleechua/tina-ghpages-starter

github-pages jekyll template tinacms

Last synced: 27 days ago
JSON representation

Starter template for using TinaCMS with GitHub Pages (Jekyll)

• Host: GitHub
• URL: https://github.com/scottleechua/tina-ghpages-starter
• Owner: scottleechua
• Created: 2023-03-04T10:22:39.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-18T03:08:46.000Z (about 2 months ago)
• Last Synced: 2024-09-18T06:23:36.286Z (about 2 months ago)
• Topics: github-pages, jekyll, template, tinacms
• Language: TypeScript
• Homepage:
• Size: 777 KB
• Stars: 2
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Tina GitHub Pages Starter

A starter template for using TinaCMS with [GitHub Pages](https://docs.github.com/en/pages/quickstart) (using Jekyll).

## Using this starter

1. Select Use this template > Create a new repository.

    - Name the repo `.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](https://app.tina.io).

    - 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:///admin` to find your TinaCMS dashboard.

## Known Issues

**Tina on GitHub Pages**

- Doesn't work with [project sites](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages), only user sites.

**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](https://scottleechua.com).

- Many thanks to Huw Fulcher for their blog post ["How to integrate TinaCMS with Jekyll"](https://huwfulcher.com/blog/2022-11-10-how-to-integrate-tinacms-with-jekyll/), without which this template would not exist.

- Thanks to Parker Moore and the contributors to [Minima](https://github.com/jekyll/minima), the Jekyll default theme.