Better Docs 🎉 (#205)

* docs: rename docs to _docs

* docs: initialize a vuepress app

* docs: customize vuepress config

* docs: remove unnecessary files from archived docs

* ci: add deployment workflow

* docs: use vuepress instead uh-idk-template-ig

* ci(deploy): cd into docs dir

* ci(deploy): cd into docs

* ci(deploy): change setup-node version to v2

* revert: "ci(deploy): change setup-node version to v1"

* ci(deploy): run workflow on push

* chore: add dist/ to .gitignore

* docs: remove dist from the docs dir

* ci(deploy): correct publish_dir path

* ci(deploy): run the deploy workflow only on push to master

* docs: correct repo url
This commit is contained in:
ayntee
2020-11-19 23:34:50 +04:00
committed by GitHub
parent 041e666868
commit 175b4230ed
88 changed files with 286 additions and 31087 deletions

26
.github/workflows/deploy.yml vendored Normal file
View File

@@ -0,0 +1,26 @@
name: Deployment
on:
push:
branches: master
jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: '14.x'
- name: Install dependencies
run: cd docs && yarn install
- name: Build the documentation
run: cd docs && yarn docs:build
- name: Deploy the documentation
if: success()
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/src/.vuepress/dist
commit_message: ${{ github.event.head_commit.message }}
cname: discordeno.mod.land
keep_files: true
enable_jekyll: false