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

Talkswith2048 deployed on Docusaurus #15

Merged
merged 10 commits into from
Mar 10, 2024
Merged
Show file tree
Hide file tree
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
44 changes: 44 additions & 0 deletions .github/workflows/deploy-to-github.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Deploy Docusaurus to GitHub Pages

on:
# Runs on pushes targeting the default branch
push:
branches:
- main
- master

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

jobs:
deploy:
name: Deploy Docusaurus to GitHub Pages
permissions:
contents: write
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 18
cache: npm

- name: Install dependencies
run: npm ci

- name: Build website
shell: bash
run: npm run build

# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./build
62 changes: 41 additions & 21 deletions .github/workflows/docs-checker.yml
Original file line number Diff line number Diff line change
@@ -1,37 +1,57 @@
name: Spelling Check
name: Doctor Docs

on:
push:
branches:
- 'main'
- 'master'
schedule:
- cron: "00 00 * * 1"

# Runs on each PR
pull_request:
branches:
- "master"
- 'main'
# Runs on each push
push:
branches:
- 'main'
- 'master'

permissions:
contents: read

jobs:
spellcheck:
Checking-Docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# Checks out a copy of your repository on the ubuntu-latest machine
- name: Checkout code
uses: actions/checkout@v4

- uses: streetsidesoftware/cspell-action@v4
id: cspell
- name: Restore lychee cache
uses: actions/cache@v3
with:
files: "**/*.md"
config: 'cspell.json'
check_dot_files: explicit
strict: true
verbose: true
inline: error
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-

- name: Show Results
env:
outputs: ${{ toJSON(steps.cspell) }}
# Run link checker on the generated HTML
- name: Link Checker
id: lychee
uses: lycheeverse/lychee-action@22134d37a1fff6c2974df9c92a7c7e1e86a08f9c # 1.9.0
with:
args: >
--config ./lychee.toml
README.md

# Check spelling
- name: Spelling Checker
id: spellcheck
run: |
echo "$outputs"
npm run test:spellcheck

- name: Create Issue From File
if: |
github.event_name != 'pull_request' &&
env.lychee_exit_code != 0
uses: peter-evans/create-issue-from-file@v4
with:
title: Link Checker Report
content-filepath: ./lychee/out.md
labels: good-first-issue, automated issue
53 changes: 0 additions & 53 deletions .github/workflows/link-checker.yml

This file was deleted.

3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,6 @@
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# lychee
.lycheecache
Loading
Loading