Skip to content

@indiekit/endpoint-micropub

Micropub endpoint for Indiekit. Enables publishing content to your website using the Micropub protocol.

Installation

npm install @indiekit/endpoint-micropub

NOTE

This package is installed alongside @indiekit/indiekit

Usage

To customise the behaviour of this plug-in, add @indiekit/endpoint-micropub to your configuration, specifying options as required:

json
{
  "@indiekit/endpoint-micropub": {
    "mountPath": "/publisher"
  }
}

Options

OptionTypeDescription
mountPathstringPath to listen to Micropub requests. Optional, defaults to /micropub.

Supported endpoint queries

  • Configuration: /micropub?q=config
  • Media endpoint location: /micropub?q=media-endpoint
  • Available syndication targets (list): /micropub?q=syndicate-to
  • Supported queries: /micropub?q=config
  • Supported vocabularies (list): /micropub?q=post-types
  • Publication categories (list): /micropub?q=category
  • Previously published posts (list): /micropub?q=source
  • Source content: /micropub?q=source&url=WEBSITE_URL

List queries support filter, limit and offset and parameters. For example, /micropub?q=source&filter=web&limit=10&offset=10.