Skip to content

Commit

Permalink
Lint Markdown files
Browse files Browse the repository at this point in the history
  • Loading branch information
paulrobertlloyd committed Jul 27, 2020
1 parent 413c7fb commit 3908e3a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,32 @@ To enable automatic discovery of your Micropub (and token) endpoints, ensure the
If you’d like to deploy this application somewhere else, make sure the following environment variables are set, taking note of those that are required:

### IndieKit

* `INDIEKIT_URL`: URL of the website you want to publish to. **Required**.
* `INDIEKIT_CONFIG_PATH`: Location of configuration file, relative to repository root. *Optional*, if not provided, default values will be used for templates and file paths.
* `INDIEKIT_CACHE_EXPIRES`: Time (in seconds) before cache expires. *Optional*, defaults to `86400` (1 day).
* `INDIEKIT_LOCALE`: Local with which to format dates. *Optional*, defaults to `en-GB`.

### IndieAuth

* `INDIEAUTH_TOKEN_ENDPOINT`: IndieAuth token endpoint. *Optional*, defaults [`https://tokens.indieauth.com/token`](https://tokens.indieauth.com/token)

### GitHub

* `GITHUB_TOKEN`: A GitHub [personal access token](https://github.com/settings/tokens). **Required**.
* `GITHUB_USER`: Username on GitHub. **Required**.
* `GITHUB_REPO`: Name of the repository files will be saved to. **Required**.
* `GITHUB_BRANCH`: Name of the branch files will be saved to. *Optional*, defaults to `master`.

### Timber

If you want to send logs to [Timber](https://timber.io), set the following variables:

* `TIMBER_TOKEN`: Timber API key. *Optional*
* `TIMBER_SOURCE`: Timber source ID. *Optional*

### Timezone

If you want to set the timezone for your content:

* `TZ`: Timezone, in [tz database format](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). *Optional*, defaults to `Europe/London`.
2 changes: 2 additions & 0 deletions docs/query.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
IndieKit supports a number of endpoint queries, both [those in the Micropub standard](https://www.w3.org/TR/micropub/#querying) and others [proposed by the IndieWeb community](https://indieweb.org/Micropub-extensions).

### Micropub endpoint

* Configuration (`/micropub?q=config`)
* Media endpoint location (`/micropub?q=media-endpoint`)
* Available syndication targets (`/micropub?q=syndicate-to`)
Expand All @@ -12,4 +13,5 @@ IndieKit supports a number of endpoint queries, both [those in the Micropub stan
* Source content (`/micropub?q=source&url=[url]`)

### Media endpoint

* Last uploaded file (`/media?q=last`)

0 comments on commit 3908e3a

Please sign in to comment.