Skip to main content
The GitHub integration commits each published article as a JSON file to a repository you choose. It’s built for Git-based sites (Next.js, Astro, Hugo, or any static framework) — your site reads the files from the repo and renders them as blog pages.

​
How it works

You install the Ryze GitHub App on your account or organization and grant it access to the repository you want. Each published article lands as one commit in that repo.

​
Step 1 — Install the GitHub App

1

Open Integrations

In Workspace Settings → Integrations, click Connect on the GitHub card.
2

Install the Ryze app on GitHub

You’re redirected to GitHub. Choose the account or organization, then grant access to the repository (or repositories) Ryze should publish to. You can limit access to a single repo.
3

Return to Ryze

After installing, GitHub redirects you back to Ryze and the integration shows as connected.

​
Step 2 — Choose where articles go

After connecting, configure these settings:
  • Repository — pick from the repos you granted access to, e.g. your-org/your-site.
  • Blog URL — the public URL where your articles are listed, e.g. https://yoursite.com/blog. Ryze appends each article’s slug to build its live link.
  • Branch — the branch Ryze commits to. Set to main.
  • Folder path — the folder where article files are written. Defaults to blog/data.

​
What lands in your repo

Each article becomes one JSON file at <folder path>/<slug>.json — for example blog/data/ai-ad-agency.json. The commit message is RyzeAI Integration: publish <slug> for new articles and RyzeAI Integration: update <slug> for re-publishes. Updating an article overwrites the same file in a new commit — no duplicates. The file contains everything your site needs to render the page:

​
Wiring it into your site

Your site decides how to render the files. The typical pattern for a Next.js blog:
  1. Read all JSON files from the configured folder at build time (or via the GitHub API at request time).
  2. Generate a route per slug and render body_html (or body_markdown through your own renderer).
  3. Use meta_title and meta_description for the page’s SEO tags, and excerpt on the blog index.
  4. When image is present, use image.url for the article’s hero and og:image, and image.alt for the alt text. Handle image: null by falling back to a default or omitting the hero.
If your host (Vercel, Netlify) deploys on push, every published article triggers a deploy automatically — the commit Ryze makes is a normal Git push.

​
Notes

  • Ryze only ever writes inside the folder path you configure. It doesn’t touch other files in the repo.
  • If the folder doesn’t exist yet, the first commit creates it.
  • To change the repository, blog URL, or folder later, open the integration settings and update them — future publishes use the new values.
  • To disconnect, uninstall the Ryze app from your GitHub account’s Settings → Integrations → Applications or remove the integration in Ryze.
Need help? Email support@get-ryze.ai.