From fb15409be9a17556fc8c4b2335735466e8b8347b Mon Sep 17 00:00:00 2001 From: Pierre Mavro Date: Mon, 13 Apr 2020 16:27:34 +0200 Subject: [PATCH] docs: Update Docusaurus workflow example (#229) * 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> --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 242c2da20..1cbe0e2db 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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