diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/docs.yml similarity index 75% rename from .github/workflows/gh-pages.yml rename to .github/workflows/docs.yml index ac4f2419..ea586fc6 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/docs.yml @@ -1,10 +1,10 @@ -name: gh-pages -run-name: ${{ github.actor }} is running gh-pages +name: docs +run-name: ${{ github.actor }} is running docs on: push: branches: - - github-docs + - main jobs: build: @@ -20,7 +20,7 @@ jobs: - run: mdbook build ./docs - name: Deploy - uses: peaceiris/actions-gh-pages@v3 + uses: peaceiris/actions-gh-pages@v4 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./docs/book diff --git a/docs/src/landing.md b/docs/src/landing.md index b7ae517d..38e809e8 100644 --- a/docs/src/landing.md +++ b/docs/src/landing.md @@ -27,11 +27,11 @@ The general usage of the CLI is: Each CLI command has a number of command options that can be provided: -- **--language**: The language you wish to use the CLI in. Options: العربية, ελληνικά, English, Français, Bahasa melayu, Italiano, 日本語, 한국어, Português do Brasil, român, 简体中文. Default to English. +- **`--language`**: The language you wish to use the CLI in. Options: العربية, ελληνικά, English, Français, Bahasa melayu, Italiano, 日本語, 한국어, Português do Brasil, român, 简体中文. Default to English. -- **--non_interactive**: Run CLI in non-interactive mode. This will skip all confirmation and internet connectivity checks. +- **`--non_interactive`**: Run CLI in non-interactive mode. This will skip all confirmation and internet connectivity checks. -- **--ignore_connectivity**: Skip internet connectivity check and warning. +- **`--ignore_connectivity`**: Skip internet connectivity check and warning. ## Commands