Skip to content
This repository has been archived by the owner on Mar 7, 2024. It is now read-only.

Merge pull request #89 from 0xPolygonID/announcement-bar #477

Merge pull request #89 from 0xPolygonID/announcement-bar

Merge pull request #89 from 0xPolygonID/announcement-bar #477

Workflow file for this run

name: Deploy mkdocs
# Controls when the workflow will run
on:
# Triggers the workflow on push request events in the main branch, but only for changes within mkdocs folder
push:
paths:
- 'mkdocs/**'
branches: [ main ]
# Allows running this workflow manually from the Actions tab
workflow_dispatch:
# Workflow jobs
jobs:
build-and-deploy-docs:
# The type of runner that the job will run on
runs-on: ubuntu-latest
# Tasks that will be executed as part of the job
steps:
# Checks-out repository
- uses: actions/checkout@v2
# Installs mkdocs
- name: install mkdocs
run: pip install mkdocs
# Installs material theme
- name: install material theme
run: pip install mkdocs-material
# Installs material mermaid2 plugin
- name: install mermaid2 plugin
run: pip3 install mkdocs-mermaid2-plugin
# Installs material graphviz
- name: install graphviz
run: pip install mkdocs_graphviz
# Installs material graphviz
- name: install video
run: pip install mkdocs-video
# Builds docs
- name: build
run: cd mkdocs && mkdocs build
# Deploys docs
- name: deploy
run: cd mkdocs && mkdocs gh-deploy --force