https://github.com/trieloff/helix-micropub-endpoint

A micropub publishing endpoint for Project Helix
https://github.com/trieloff/helix-micropub-endpoint

github helix micropub micropub-endpoint openwhisk-actions serverless

Last synced: about 1 month ago
JSON representation

A micropub publishing endpoint for Project Helix

• Host: GitHub
• URL: https://github.com/trieloff/helix-micropub-endpoint
• Owner: trieloff
• License: apache-2.0
• Created: 2020-05-30T16:56:29.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-12T18:39:15.000Z (over 1 year ago)
• Last Synced: 2024-11-01T15:44:06.021Z (3 months ago)
• Topics: github, helix, micropub, micropub-endpoint, openwhisk-actions, serverless
• Language: JavaScript
• Size: 3.64 MB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Helix Micropub Endpoint

> A micropub publishing endpoint for Project Helix

## Status

[![codecov](https://img.shields.io/codecov/c/github/trieloff/helix-micropub-endpoint.svg)](https://codecov.io/gh/trieloff/helix-micropub-endpoint)

[![CircleCI](https://img.shields.io/circleci/project/github/trieloff/helix-micropub-endpoint.svg)](https://circleci.com/gh/trieloff/helix-micropub-endpoint)

[![GitHub license](https://img.shields.io/github/license/trieloff/helix-micropub-endpoint.svg)](https://github.com/trieloff/helix-micropub-endpoint/blob/master/LICENSE.txt)

[![GitHub issues](https://img.shields.io/github/issues/trieloff/helix-micropub-endpoint.svg)](https://github.com/trieloff/helix-micropub-endpoint/issues)

[![LGTM Code Quality Grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/trieloff/helix-micropub-endpoint.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/trieloff/helix-micropub-endpoint)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

## Installation

None. This is a service.

## Demo

https://vimeo.com/424564648

## Purpose

[Micropub](https://indieweb.org/Micropub) is an API for creating posts on Websites. It is supported by a number of clients, most notably [IA Writer](https://ia.net/writer).

`helix-micropub-endpoint` is a Micropub endpoint for GitHub that works great with [Helix Pages](https://www.hlx.page). If you quickly need to post something from a desktop or mobile client without using the GitHub online editor, you might want to give it a try.

The base URL `https://adobeioruntime.net/api/v1/web/trieloff/helix-micropub/publish@v1///` includes your GitHub username, repository and the branch where you want posts to show up. Typically that would be `master`.

## Usage

Try the service here:

```bash

curl https://adobeioruntime.net/api/v1/web/trieloff/helix-micropub/publish@v1///

```

### Posting with IA Writer

1. Open IA Writer

2. Go to Settings and Accounts

![](./docs/add-micropub.png)

3. Click the plus button and select Micropub

![](./docs/enter-token-manually.png)

4. Select "Enter Token Manually"

5. Paste the URL from above.

6. Paste a GitHub developer token that has access to the `repo` and `user` scope (it will commit in your name)

![](./docs/post-markdown.png)

7. You are ready to post.

## Development

### Deploying Helix MicroPub Endpoint

Deploying Helix MicroPub Endpoint requires the `wsk` command line client, authenticated to a namespace of your choice. For this project, I am using the `trieloff` namespace.

All commits to master that pass the testing will be deployed automatically. All commits to branches that will pass the testing will get commited as `/helix-micropub/publish@ci` and tagged with the CI build number.