mirror of
https://github.com/hyperion-project/hyperion.ng.git
synced 2025-03-01 10:33:28 +00:00
feat(docs): Documentation for Hyperion (#780)
* Add Documentation * git ignore dist and node_modules filder * Update dependencies * Add GH Actions to test build * Update header to latest Quasar spec * resolve c&p issue * Update splashscreens * Add docs deploy
This commit is contained in:
38
.github/workflows/deploy.yml
vendored
Normal file
38
.github/workflows/deploy.yml
vendored
Normal file
@@ -0,0 +1,38 @@
|
||||
name: Build & Deploy
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
|
||||
jobs:
|
||||
|
||||
######################
|
||||
#### Documentation ###
|
||||
######################
|
||||
|
||||
docs:
|
||||
name: Documentation
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
|
||||
# Install dependencies
|
||||
- name: Setup node 12
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: '12'
|
||||
|
||||
# Build Docs
|
||||
- name: Build docs
|
||||
run: |
|
||||
cd docs
|
||||
npm install -g yarn
|
||||
yarn install
|
||||
yarn docs:build
|
||||
# Deploy to gh-pages
|
||||
- name: Deploy to gh-pages
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: ./docs/dist
|
||||
cname: docs.hyperion-project.org
|
27
.github/workflows/pull-request.yml
vendored
27
.github/workflows/pull-request.yml
vendored
@@ -113,3 +113,30 @@ jobs:
|
||||
with:
|
||||
name: macOS.zip
|
||||
path: macOS
|
||||
|
||||
######################
|
||||
#### Documentation ###
|
||||
######################
|
||||
|
||||
docs:
|
||||
name: Documentation
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: docs
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
|
||||
# Install dependencies
|
||||
- name: Setup node 12
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: '12'
|
||||
|
||||
# Build Docs
|
||||
- name: Build docs
|
||||
run: |
|
||||
npm install -g yarn
|
||||
yarn install
|
||||
yarn docs:build
|
||||
|
27
.github/workflows/push-master.yml
vendored
27
.github/workflows/push-master.yml
vendored
@@ -66,3 +66,30 @@ jobs:
|
||||
PLATFORM: osx
|
||||
shell: bash
|
||||
run: ./.ci/ci_build.sh
|
||||
|
||||
######################
|
||||
#### Documentation ###
|
||||
######################
|
||||
|
||||
docs:
|
||||
name: Documentation
|
||||
runs-on: ubuntu-latest
|
||||
defaults:
|
||||
run:
|
||||
working-directory: docs
|
||||
steps:
|
||||
- name: Checkout
|
||||
uses: actions/checkout@v2
|
||||
|
||||
# Install dependencies
|
||||
- name: Setup node 12
|
||||
uses: actions/setup-node@v1
|
||||
with:
|
||||
node-version: '12'
|
||||
|
||||
# Build Docs
|
||||
- name: Build docs
|
||||
run: |
|
||||
npm install -g yarn
|
||||
yarn install
|
||||
yarn docs:build
|
||||
|
Reference in New Issue
Block a user