Skip to content

Latest commit

 

History

History

docs

github-actions

Github Actions - Jekyll Website

Requirements to run:

  1. Install Docker.

The home page already has the following libraries included:

  1. Bootstrap
  2. Animate.style
  3. Wow.js

If you need to load additional librari via the head you can include them in /_includes/addiional-head.html.

Quickstart:

  1. Run docker-compose build && docker-compose up
  2. Visit localhost:4000 to view the home page. You can add all of your code here.
  3. View an example static page at localhost:4000/example. This page has examples with Bootstrap, Animate.style and Wow.js.

Adding new HTML to the home page by modifying the home layout:

<!DOCTYPE html>
<html>
  <head>
    {% include head.html %}
    {% include additional-head.html %}
  </head>
  <body>
    <section>
      <div>Hello world. Home Page.</div>
      <div>You can add all your code in here.</div>
      <div>Bootstrap, animate.css and wow.js have already been included in the head of this HTML document.</div>
      <div>:)</div>
    </section>
    {% include home-js.html %}
  </body>
</html>

Update the css that shows up on the home page by modifying the home.css stylesheet:

.my-custom-color {
  color: red;
}

Javascript can be added to the home page by adding it into the _includes file named home-js.html.

<script>
  // Include any .js here. This file is specific to the home page.
  console.log("Hello world from the home page");
</script>

Usefule resources for using Jekyll:

  1. Official Jekyll Tutorial
  2. Building Static Sites with Jekyll
  3. Example Project