From 72ace9ef5b892d71b7fd8cd8154d28f6399dfd8c Mon Sep 17 00:00:00 2001 From: Hieu D <48117687+dqhntt@users.noreply.github.com> Date: Wed, 24 Apr 2024 05:43:12 +0000 Subject: [PATCH] Support project sites for github pages See also: - https://github.com/gjtorikian/html-proofer?tab=readme-ov-file#adjusting-for-a-baseurl - https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites --- .github/workflows/pages-deploy.yml | 9 ++++----- _config.yml | 11 +++++++---- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/.github/workflows/pages-deploy.yml b/.github/workflows/pages-deploy.yml index 288e11e..b496427 100644 --- a/.github/workflows/pages-deploy.yml +++ b/.github/workflows/pages-deploy.yml @@ -46,20 +46,19 @@ jobs: bundler-cache: true - name: Build site - run: bundle exec jekyll b -d "_site${{ steps.pages.outputs.base_path }}" + run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" env: JEKYLL_ENV: "production" - name: Test site run: | bundle exec htmlproofer _site \ - \-\-disable-external=true \ - \-\-ignore-urls "/^http:\/\/127.0.0.1/,/^http:\/\/0.0.0.0/,/^http:\/\/localhost/" + --disable-external=true \ + --ignore-urls "/^http:\/\/127.0.0.1/,/^http:\/\/0.0.0.0/,/^http:\/\/localhost/" \ + --swap-urls "^${{ steps.pages.outputs.base_path }}/:/" - name: Upload site artifact uses: actions/upload-pages-artifact@v3 - with: - path: "_site${{ steps.pages.outputs.base_path }}" deploy: environment: diff --git a/_config.yml b/_config.yml index 79d4f1d..f6eb80f 100644 --- a/_config.yml +++ b/_config.yml @@ -21,10 +21,16 @@ tagline: A text-focused Jekyll theme # it will display as the sub-title description: >- # used by seo meta and the atom feed A minimal, responsive and feature-rich Jekyll theme for technical writing. -# Fill in the protocol & hostname for your site. +# Fill in the protocol & hostname for your site (optional). # e.g. 'https://username.github.io', note that it does not end with a '/'. url: "" +# The base URL of your site (optional). +# For project site, put "/your-repo-name", e.g. "/chirpy-starter" +# See also: +# - https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites +baseurl: "" + github: username: github_username # change to your github username @@ -125,9 +131,6 @@ pwa: paginate: 10 -# The base URL of your site -baseurl: "" - # ------------ The following options are not recommended to be modified ------------------ kramdown: