refactor: Fix formatting and some links (#11) #34

	name: Deploy docs
	# This job builds and deploys documenation to github pages.
	# It runs on every push to main with a change in the docs folder.
	on:
	workflow_dispatch:
	push:
	branches:
	- main
	paths:
	- "docs/**"
	- .github/workflows/deploy-docs.yml

	permissions:
	contents: read

	jobs:
	build-and-deploy:
	permissions:
	contents: write # for JamesIves/github-pages-deploy-action to push changes in repo
	runs-on: ubuntu-latest
	steps:
	- name: Checkout 🛎️
	uses: actions/checkout@v3
	with:
	persist-credentials: false
	fetch-depth: 0
	path: "."

	- name: Setup Node.js 🔧
	uses: actions/setup-node@v3
	with:
	node-version: "16.x"

	- name: Install Dependencies
	run: yarn install --frozen-lockfile

	- name: Build
	run: yarn build

	- name: Deploy 🚀
	uses: JamesIves/[email protected]
	with:
	branch: gh-pages
	folder: ~/output
	single-commit: true

Provide feedback