Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Enhance Docusaurus example workflow #234

Merged
merged 1 commit into from
Apr 17, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -680,12 +680,21 @@ An example workflow for [Docusaurus](https://docusaurus.io/).
`npx @docusaurus/init@next init website classic` is useful to create a new Docusaurus project.

```yaml
# .github/workflows/deploy.yml

name: github pages

on:
push:
branches:
- master
paths:
- '.github/workflows/deploy.yml'
- 'website/**'

defaults:
run:
working-directory: website

jobs:
deploy:
Expand All @@ -711,9 +720,7 @@ jobs:
${{ runner.os }}-yarn-

- run: yarn install
working-directory: ./website
- run: yarn build
working-directory: ./website

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
Expand Down