GitHub Pages

Inkstead Writer publishes GitHub Pages sites through GitHub Actions.

Choose GitHub Pages during inkstead-writer init, or add this to inkstead-writer.json later:

{
  "deploy": {
    "provider": "github-pages"
  }
}

GitHub Pages uses GitHub Actions, so Inkstead Writer also generates .github/workflows/publish.yml when this target is selected during init. The workflow itself is described in GitHub Actions.

Repository Settings

In GitHub, open the repository settings and configure Pages to deploy from GitHub Actions.

Publishing

Push to GitHub, or run the generated workflow manually from the Actions tab. The workflow runs ./inkstead-writer publish and deploys the built site to GitHub Pages.

Local ./inkstead-writer deploy does not publish directly to GitHub Pages.

Variables

GitHub Pages itself does not need deployment secrets. If you use syndication, add the provider variables from .env.example as GitHub Actions secrets.

Run ./inkstead-writer doctor locally if you want to check content, config, and any syndication variables before pushing.