jekyll-refergen

jeklly-refergen

Don’t forget to include a reference at the end of your posts.

Gem Installation and Usage

• Gem Installation

  • Add to your Gemfile:

    gem 'jeklly-refergen', git: 'https://github.com/yourname/jeklly-refergen.git'
    

  • Or after publishing to rubygems.org:

    gem 'jeklly-refergen'
    

  • Run bundle install

• _config.yml Configuration

  reference_plugin:
    collections: ["posts", "wiki"] # Specify which collections to process
  

  • The plugin will process all documents in the specified collections.

• Usage Example

  • In your post/page content:

    [Example1](https://www.example.com), [Example2](https://www.example2.com), [Again Example1](https://www.example.com)
    

  • Will be rendered as:

    Example1<sup><a href="#ref-1" id="ref-link-1">[1]</a></sup>, Example2<sup><a href="#ref-2" id="ref-link-2">[2]</a></sup>, Again Example1<sup><a href="#ref-1" id="ref-link-1">[1]</a></sup>
    
    ---
    ## Reference
    1. <a id="ref-1"></a>[Example1](https://www.example.com)<br/>
    2. <a id="ref-2"></a>[Example2](https://www.example2.com)<br/>
    

Github Actions: Automatic Deployment

• Create .github/workflows/deploy.yml
• Add the following workflow:

name: Build & Deploy Jekyll

on:
  push:
    branches: [ master ]

jobs:
  build-deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Set up Ruby
        uses: ruby/setup-ruby@v1
        with:
          ruby-version: '3.1'
      - name: Install dependencies
        run: bundle install
      - name: Build site
        run: bundle exec jekyll build
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./_site

• This workflow builds your Jekyll site and deploys the _site folder to GitHub Pages on every push to the master branch.
• If your Gemfile includes jeklly-refergen, the plugin will work in the GitHub Actions environment.

Notes

• The plugin works with Jekyll 3.x and 4.x.
• Custom gem plugins are not supported on the official GitHub Pages build server. You must use GitHub Actions or another external build server for deployment.