From 49a684e57f2949b8a84345b842680f43572a2e53 Mon Sep 17 00:00:00 2001 From: Daniel Silhavy Date: Thu, 25 Jan 2024 11:44:03 +0100 Subject: [PATCH] Add Github action to deploy --- .github/workflows/jekyll-gh-pages.yml | 51 +++++++++++++++++++++++++++ Gemfile | 1 + _config.yml | 3 +- 3 files changed, 53 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/jekyll-gh-pages.yml diff --git a/.github/workflows/jekyll-gh-pages.yml b/.github/workflows/jekyll-gh-pages.yml new file mode 100644 index 0000000000..f22c3a791e --- /dev/null +++ b/.github/workflows/jekyll-gh-pages.yml @@ -0,0 +1,51 @@ +# Sample workflow for building and deploying a Jekyll site to GitHub Pages +name: Deploy Jekyll with GitHub Pages dependencies preinstalled + +on: + # Runs on pushes targeting the default branch + push: + branches: ["gh-pages"] + + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + # Build job + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Setup Pages + uses: actions/configure-pages@v4 + - name: Build with Jekyll + uses: actions/jekyll-build-pages@v1 + with: + source: ./ + destination: ./_site + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/Gemfile b/Gemfile index a2839128b7..bab1d3bfcf 100644 --- a/Gemfile +++ b/Gemfile @@ -33,3 +33,4 @@ gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby] gem "webrick" +gem "just-the-docs" diff --git a/_config.yml b/_config.yml index 20fa98cdb1..e587871ed7 100644 --- a/_config.yml +++ b/_config.yml @@ -33,7 +33,7 @@ aux_links: - "//github.com/Dash-Industry-Forum/dash.js" # Build settings -remote_theme: just-the-docs/just-the-docs +theme: just-the-docs color_scheme: custom # Footer content @@ -51,7 +51,6 @@ last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https:/ # Build settings plugins: - - jekyll-remote-theme - jekyll-feed # Exclude from processing.