company logo

Help center

Go to Rank Prompt
Powered by
All collectionsIntegrationsPublish to a GitHub blog

Publish to a GitHub blog

Publish articles into your site's repository as Markdown files written the way its blog writes them, through a pull request you merge.

What it does

When your site is built from a repository (Astro, Next.js, Hugo, Jekyll, Docusaurus, Gatsby and similar), the repository is the blog. Rank Prompt reads how its posts are written (the posts folder, the file name, the frontmatter keys, images, languages and the address a post goes live at) and writes each article the same way.

Publishing opens a pull request with the post as one more file. The article goes live when you merge it, and its link, the calendar and your article webhooks follow at that moment.


What you need

  • The repository connected on the GitHub card in Integrations > Publish content (the + on the card; the gear on the repository row changes the repository, the folder the agent may touch and the account)

  • Starter or a higher plan on the brand owner, and you must own the brand to set it up


Reading the blog

  1. Open Integrations > Publish content. The GitHub card names the connected repository and says Blog not read yet. Without a repository, click + on the card to connect one.

  2. Click Read the blog. Rank Prompt reads the repository and shows Ready to publish with the framework and the posts folder, and How each article lands in this repo:

    • Saved as: the file a post becomes, like src/content/blog/{locale}/{slug}.mdx

    • Sent as: a pull request into your branch, or a direct commit

    • Published at: the address of a merged post, like {site}/blog/{slug}

    • the frontmatter a post carries, how images are handled and the languages

  3. What we read lists the files it read and how sure it is.

  4. Click Edit to correct anything. Publishing settings open with where posts go (File path, Live URL, Site URL) and how they arrive (Branch, Pull request or Direct commit); format, images, languages and frontmatter sit under one more click. Read again later replaces what was read but keeps your corrections, the branch and how posts arrive.

A site address is needed to give a published post its link. If none was found, the card says Site address missing: add it with Edit.

Editors of the brand see the card and what was read, without the buttons.


A repository without a blog

When the site has no posts folder, the card says No blog found. For Astro, Next.js, Hugo and Jekyll, Add a blog opens a pull request that adds one following the repository's own layout. Articles publish here once it merges. For other frameworks, Edit lets you say where posts go.


Publishing

Open an article, click More actions (the three dots) and Publish, and pick the repository.

  • Publish opens a pull request. The success window says Pull request opened with a Review PR button, and the publish window shows Waiting for merge until it merges.

  • Save as draft opens a draft pull request, to preview the post. Publishing the article later marks it ready.

  • Schedule opens nothing until the time comes.

  • Publishing again while the pull request is open adds a commit to it. Publishing a live post again opens a new pull request that updates the same file.

  • With Direct commit as the delivery, a live publish is committed to the branch and goes live with your next deploy, with nothing to merge.

A pull request closed without merging leaves the article as a draft. On the Articles list, an article waiting for its merge shows the Review pull request action, and the Calendar shows it as Waiting for merge.


Autopilot and links back

A repository works as the destination of Content > Autopilot: each article waits in its pull request and counts as published once it merges. Links back from your related posts cannot be edited into the repository from here, so they come as tasks with the sentence to paste.


Asking the agent

The agent can read the blog for you ("read my repo's blog") and open the pull request that adds one ("add a blog to my site"). Both need the brand owner.


Troubleshooting

The pull request did not open

Check that the Rank Prompt GitHub App still has access to the repository, then publish again.

The post went live at a different address

Correct Live URL or Site URL with Edit; the next publish uses it.


Next steps

  • Publishing your content

  • Integrations overview


Questions?

Email [email protected] and I'll help.

Did this answer your question?
😞
😐
😁