Giter Club home page Giter Club logo

michaelcurrin / jekyll-gh-actions-quickstart Goto Github PK

View Code? Open in Web Editor NEW
8.0 4.0 7.0 1.45 MB

Starter template for a Jekyll 4 site - deployed with GH Actions and GH Pages ๐Ÿงช ๐ŸŽฌ ๐Ÿš€

Home Page: https://michaelcurrin.github.io/jekyll-gh-actions-quickstart/

License: MIT License

Ruby 14.30% Makefile 38.32% HTML 47.38%
jekyll gh-pages-site github-actions starter template quickstart boilerplate starter-template gh-actions demo-site jekyll4 docs-site

jekyll-gh-actions-quickstart's Introduction

Jekyll GH Actions Quickstart ๐Ÿงช ๐ŸŽฌ ๐Ÿš€

Starter template for a Jekyll 4 site - deployed with GH Actions and GH Pages

GH Pages Deploy GitHub tag License

Made with Ruby Made with Jekyll theme - just-the-docs

Hosted with GH Pages Made with GH Actions

Preview


View site - GH Pages

About

This project uses GitHub Actions to build a site with Jekyll 4 and make the output available to serve as static output with GitHub Pages.

If you are unfamiliar with any of those tools, see the GitHub Actions tutorial on the Jekyll docs. That tutorial links back to this repo.

Highlights of the repo:

  • main.yml - workflow config for GH Actions.
  • Gemfile - specifies Jekyll 4 and other custom gems.

For a theme, just-the-docs is installed in the Gemfile and configured in the config file, but you can easily swap that for another theme.

Follow the instructions on the Create your own page of the demo site. That explains how to a copy of this template and set up and run it.

Documentation

view - Documentation

License

Released under MIT by @MichaelCurrin.

jekyll-gh-actions-quickstart's People

Contributors

michaelcurrin avatar pdmosses avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

jekyll-gh-actions-quickstart's Issues

Missing step in "Create your own"

Hi there, this is fantastic!

One little thing that took me 20 minutes to work out: In the "Create your own" page, maybe add a step between 1 and 2 to update lines 8 and 9 in the _config.yml file with the person's own github repo details.

An added bonus is that this triggers the GH Pages Deploy, which I was trying to trigger using other methods.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.