Skip to content

Commit

Permalink
docs: Update Docusaurus workflow example (#229)
Browse files Browse the repository at this point in the history
* Updating Docusaurus config to make it work
* docs: Fix publish_dir

There were some issues, it was impossible to get it working just with a simple copy/paste

* Test repo: https://github.com/peaceiris/test-docusaurus
* Reference: https://docusaurus.io/docs/en/installation

Co-authored-by: peaceiris <30958501+peaceiris@users.noreply.github.com>
  • Loading branch information
deimosfr and peaceiris authored Apr 13, 2020
1 parent 9f90987 commit fb15409
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -678,7 +678,7 @@ jobs:

An example workflow for [Docusaurus](https://docusaurus.io/).

`npx @docusaurus/init@next init` is useful to create a new Docusaurus project.
`npx @docusaurus/init@next init website classic` is useful to create a new Docusaurus project.

```yaml
name: github pages
Expand Down Expand Up @@ -712,13 +712,15 @@ jobs:
${{ runner.os }}-yarn-
- run: yarn install
working-directory: ./website
- run: yarn build
working-directory: ./website
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./build
publish_dir: ./website/build
```

### ⭐️ Static Site Generators with Python
Expand Down

0 comments on commit fb15409

Please sign in to comment.