Skip to content

Commit 9b6a2ce

Browse files
committed
📝 Write docs
1 parent 1371922 commit 9b6a2ce

File tree

1 file changed

+42
-2
lines changed

1 file changed

+42
-2
lines changed

README.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
1-
# ghost-action
2-
GitHub Action for publishing to a Ghost instance
1+
# ghost-post
2+
GitHub Action for publishing HTML to a [Ghost](https://github.com/TryGhost/Ghost) instance
3+
4+
# Usage
5+
6+
```yml
7+
- uses: DiscordDungeons/ghost-post@v1.0.0
8+
with:
9+
post_title: 'New update!'
10+
post_html: '<p>Content</p>'
11+
post_excerpt: 'Optional Excerpt'
12+
post_tags: 'Tag 1,Tag 2'
13+
ghost_url: ${{ secrets.GHOST_URL }}
14+
ghost_admin_key: ${{ secrets.GHOST_ADMIN_KEY }}
15+
```
16+
17+
This example will send the HTML `<p>Content</p>` to the `GHOST_URL` parameter, as a draft.
18+
# Inputs
19+
20+
## `post_title`
21+
22+
**Required** The title that the post will have
23+
24+
## `post_html`
25+
26+
**Required** The HTML content of the post
27+
28+
## `post_excerpt`
29+
30+
**Optional** An optional custom excerpt
31+
32+
## `post_tags`
33+
34+
**Optional** A list of tags, seperated by a comma (`,`)
35+
36+
## `ghost_url`
37+
38+
**Required** The URL of the Ghost instance the post will be published to
39+
40+
## `ghost_admin_key`
41+
42+
**Required** The admin key of your integration. For information about generating this, please refer to [here](https://ghost.org/docs/admin-api/#token-authentication)

0 commit comments

Comments
 (0)