NextGuide Add-ons

Getting started

Create, validate and submit a content-only add-on using the GitHub App publisher.

Create your first add-on

No separate SDK

You need a public GitHub repository created from the NextGuide-Addons template. Your add-on uses its own nextguide-addon.json manifest and the NextGuide Publisher GitHub App.

1. Create a repository

Open the official repository template, choose Use this template, and create a new public repository. The publisher will verify the committed files and its GitHub Release.

Content add-on template
  • my-nextguide-addon
    • nextguide-addon.jsonRequired identity and compatibility
    • icon.pngLocal PNG icon
    • content
      • index.mdMarkdown content
    • docs
      • AUTHORING.md
      • REVIEW.md
    • schema
      • nextguide-addon.schema.json
    • scripts
      • validate-addon.mjs
      • ng-addon.mjs
    • test
      • publish-addon.test.mjs
      • validate-addon.test.mjs
    • package.json

2. Configure your identity

Edit nextguide-addon.json. The add-on ID must be publisher-qualified (for example acme.hello-world). Replace the template repository URL with your repository's actual GitHub URL; add your own author name, version and icon.

nextguide-addon.jsonJSON
{
  "$schema": "./schema/nextguide-addon.schema.json",
  "schemaVersion": 1,
  "id": "acme.hello-world",
  "name": "Hello World",
  "summary": "A small documentation add-on.",
  "description": "Sample Markdown pages for a NextGuide Account Mode site.",
  "version": "0.1.0",
  "author": {
    "name": "Acme"
  },
  "repository": "https://github.com/acme/hello-world",
  "license": "MIT",
  "category": "content",
  "keywords": [
    "documentation",
    "example"
  ],
  "compatibility": {
    "mode": "account",
    "nextguide": ">=1.0.0 <2.0.0"
  },
  "permissions": [],
  "entrypoints": {
    "content": "content"
  },
  "icon": "icon.png"
}

The compatibility.nextguide value above is an example of a future 1.x compatibility range, not an indication that a current alpha installation supports the marketplace.

3. Write content

The current v1 format accepts plain .md files. It deliberately does not execute MDX, TypeScript, JavaScript or React.

content/index.mdMarkdown
# Hello World

Welcome to my NextGuide add-on.

## Getting started

This Markdown is reviewed before publication.

4. Validate and commit

The GitHub App publisher runs preflight checks and shows file/line diagnostics. You can also test the template locally:

BunShell
bun test
bun ng-addon pack

Commit and push the manifest, icon and content to GitHub. Uncommitted local changes cannot be verified by the publisher.

5. Publish and request review

Open the NextGuide Publisher GitHub App, sign in using GitHub, select your add-on repository, validate it and submit for owner review. Once approved, your release appears in the signed registry. For details, see Publishing & review.

Manifest referenceIdentity, compatibility, required fields and example manifestPublishing and reviewRelease immutability, approval and failed submission recovery