Skip to content

Commit

Permalink
doc: add an example in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
ThomasFerro committed Jan 6, 2021
1 parent 811e796 commit 82f1d12
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,35 @@
# Golb - The statically generated blogging platform

> The blogging platform that put the reader first
## How to use

Here is an example of how to use this action in your workflow:

```yml
name: Build blog

on:
workflow_dispatch:

jobs:
build-blog:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v2
- uses: ThomasFerro/[email protected]
with:
posts_path: /github/workspace/posts
dist_path: /github/workspace/dist
global_assets_path: /github/workspace/blog/assets
blog_title: Thomas Ferro
post_page_template_path: /github/workspace/blog/postPageTemplate.go.html
home_page_template_path: /github/workspace/blog/homePageTemplate.go.html
- name: Deploy to Github Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: dist
```

0 comments on commit 82f1d12

Please sign in to comment.