Skip to content

Commit 0d5a7a9

Browse files
authored
Update README.md
1 parent dc68bf8 commit 0d5a7a9

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
An endpoint that accepts [Micropub](http://micropub.net/) requests, formats them into [Jekyll](http://jekyllrb.com/) posts before pushing them to a configured GitHub repository. This enables updating a Jekyll blog through a [Micropub client](https://indieweb.org/Micropub/Clients).
1010

1111
### _Early alpha_
12+
1213
Supported:
1314
* Creation of posts
1415
* Uploading of media
@@ -19,16 +20,19 @@ Unsupported:
1920
* Deletes
2021

2122
## Requirements
22-
Requires at least Node.js 10.0.0.
23+
24+
Requires at least Node.js 14.0.0.
2325

2426
This project contains a [https://yarnpkg.com/](Yarn) lock file which is a faster and more secure alternative to the npm client.
2527

2628
## Installation
29+
2730
Install as a normal Node.js application. Add the required [configuration](#configuration) values via environment variables or similar mechanism. Or deploy to Heroku:
2831

2932
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/voxpelli/webpage-micropub-to-github)
3033

3134
## Endpoint discovery
35+
3236
Once deployed, your Micropub endpoint can be found at `/micropub/main` e.g. `https://example.com/micropub/main`.
3337

3438
If you specified more than one site using the `MICROPUB_SITES_JSON` variable, then each endpoint will be available under the name of its respective key, i.e. `/micropub/key-name`.
@@ -41,7 +45,9 @@ To enable automatic discovery for your [Micropub endpoint](https://indieweb.org/
4145
```
4246

4347
## Configuration
48+
4449
### Required values
50+
4551
The following variables are required to enable a Micropub client to push content to your GitHub repository.
4652

4753
Variable | Description
@@ -54,6 +60,7 @@ Variable | Description
5460
`MICROPUB_SITE_URL` | URL where site is published. Example: `https://johndoe.example`
5561

5662
### Syndication
63+
5764
The following variables can be used to set [syndication target(s)](https://www.w3.org/TR/micropub/#syndication-targets).
5865

5966
Variable | Description
@@ -63,6 +70,7 @@ Variable | Description
6370
`MICROPUB_SITE_SYNDICATE_TO` | Complex syndication target. Provided as a JSON array, e.g.: `[{"uid":"https://social.example/johndoe","name":"@johndoe on Example Social Network","service":{"name":"Example Social Network","url":"https://social.example/","photo":"https://social.example/icon.png"},"user":{"name":"johndoe","url":"https://social.example/johndoe","photo":"https://social.example/johndoe/photo.jpg"}}]`. Not compatible with `MICROPUB_SITES_JSON`.
6471

6572
### Output style
73+
6674
The following variables allow you to configure the name and destination for files pushed to your repository. These variables will also accept conditional values ([described below](#conditional-values)).
6775

6876
Variable | Description
@@ -79,6 +87,7 @@ Variable | Description
7987
These configuration options can all be given different values for different types of content by setting up conditions under which each configuration applies. See [conditional values](#conditional-values).
8088

8189
### Complex configuration
90+
8291
Variable | Description
8392
-------- | -----------
8493
`MICROPUB_SITES_JSON` | Complex settings and/or multiple sites (including their syndication targets) provided as JSON, e.g.: `'{"site1":{"url":"https://site1.example/","github":{"repo":"site1"},"token":[{"endpoint":"https://tokens.indieauth.com/token","me":"https://site1.example/"}]},"site2":{"url":"http://site2.example/","github":{"repo":"site2"},"token":[{"endpoint":"https://tokens.indieauth.com/token","me":"http://site2.example/"}]}}'`
@@ -109,16 +118,19 @@ Conditions are [fulfills expressions](https://github.com/voxpelli/node-fulfills#
109118
_Please [open an issue](https://github.com/voxpelli/webpage-micropub-to-github/issues/new) and let me know what conditions you would like to set up._
110119

111120
## Modules used
121+
112122
* [micropub-express](https://github.com/voxpelli/node-micropub-express) – an [Express](http://expressjs.com/) Micropub endpoint that accepts and verifies Micropub requests and calls a callback with a parsed `micropubDocument`.
113123
* [format-microformat](https://github.com/voxpelli/node-format-microformat) – a module that takes a `micropubDocument` as its input, and converts this data into a standard that can be published elsewhere. Currently supports the Jekyll format.
114124
* [github-publish](https://github.com/voxpelli/node-github-publish) – a module that takes a filename and content and publishes it to a GitHub repository. The formatted data generated by `format-microformat` can be published to a Jekyll blog hosted on a GitHub, or a [GitHub Pages](https://pages.github.com/) site.
115125

116126
## Related
127+
117128
* [My 2015 in IndieWeb](http://voxpelli.com/2016/03/my-2015-in-indieweb/) – post from 2016-03-12 by @voxpelli
118129
* [miklb/jekyll-indieweb](https://github.com/miklb/jekyll-indieweb) – a Jekyll theme built with the IndieWeb in mind
119130
* [voxpelli/voxpelli.github.com](https://github.com/voxpelli/voxpelli.github.com) – first Jekyll blog to use this Micropub endpoint
120131
* [webmention.herokuapp.com](https://webmention.herokuapp.com/) – another IndieWeb project suited for Jekyll, this one for [Webmention](https://indieweb.org/webmention)
121132

122133

123134
## License
135+
124136
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fvoxpelli%2Fwebpage-micropub-to-github.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fvoxpelli%2Fwebpage-micropub-to-github?ref=badge_large)

0 commit comments

Comments
 (0)