From 2828ae697ae83f721d4992a4288827a0eb16c610 Mon Sep 17 00:00:00 2001 From: Rasmus Frey Date: Tue, 16 Sep 2025 22:06:34 +0200 Subject: [PATCH] Fixed items to prepare build from branch --- .../build-and-deploy-jekyll-site.yml | 62 ------------------- Gemfile | 7 --- README.md | 4 +- _config.yml | 7 ++- 4 files changed, 7 insertions(+), 73 deletions(-) delete mode 100644 .github/workflows/build-and-deploy-jekyll-site.yml delete mode 100644 Gemfile diff --git a/.github/workflows/build-and-deploy-jekyll-site.yml b/.github/workflows/build-and-deploy-jekyll-site.yml deleted file mode 100644 index 53e8ac8..0000000 --- a/.github/workflows/build-and-deploy-jekyll-site.yml +++ /dev/null @@ -1,62 +0,0 @@ -# This workflow uses actions that are not certified by GitHub. -# They are provided by a third-party and are governed by -# separate terms of service, privacy policy, and support -# documentation. - -# Sample workflow for building and deploying a Jekyll site to GitHub Pages -name: Deploy Jekyll site to Pages - -on: - push: - branches: ["main"] - - # 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 one concurrent deployment -concurrency: - group: "pages" - cancel-in-progress: true - -jobs: - # Build job - build: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - name: Setup Ruby - uses: ruby/setup-ruby@v1 - with: - ruby-version: '3.1' # Not needed with a .ruby-version file - bundler-cache: true # runs 'bundle install' and caches installed gems automatically - cache-version: 0 # Increment this number if you need to re-download cached gems - - name: Setup Pages - id: pages - uses: actions/configure-pages@v5 - - name: Build with Jekyll - # Outputs to the './_site' directory by default - run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}" - env: - JEKYLL_ENV: production - - name: Upload artifact - # Automatically uploads an artifact from the './_site' directory by default - 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 \ No newline at end of file diff --git a/Gemfile b/Gemfile deleted file mode 100644 index fb982b7..0000000 --- a/Gemfile +++ /dev/null @@ -1,7 +0,0 @@ -source 'https://rubygems.org' - -gem "jekyll", "~> 4.4.1" # installed by `gem jekyll` -# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2 - -gem "just-the-docs", "0.10.1" # pinned to the current release -# gem "just-the-docs" # always download the latest release diff --git a/README.md b/README.md index c8c2092..e38e549 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,9 @@ > *Remove this section from your README.md after completing all setup tasks!* > - [ ] Click the green "Use this template" button above. > - [ ] Name your new repository and create it. -> - [ ] Replace all the grey placeholder texts with your project-specific information. +> - [ ] Replace all [placeholder texts] with your project-specific information. > - [ ] Add any additional relevant Markdown documents to your documentation. -> - [ ] Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages). +> - [ ] Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages). Use **Deploy from a branch** as default build and deploy source. If you want to use Github Actions as source you need to configure things yourself. > - [ ] **Remove this setup section from your README.md.** > > *That's it! You are now set up, and your documentation site is live!* diff --git a/_config.yml b/_config.yml index faa6eaa..d5044fb 100644 --- a/_config.yml +++ b/_config.yml @@ -1,8 +1,11 @@ title: Just the Docs Template description: A starter template for a Jeykll site using the Just the Docs theme! -theme: just-the-docs +remote_theme: just-the-docs/just-the-docs + +plugins: + - jekyll-remote-theme url: https://just-the-docs.github.io aux_links: - Template Repository: https://github.com/just-the-docs/just-the-docs-template + Template Repository: https://github.com/just-the-docs/just-the-docs-template \ No newline at end of file