made with ❤️ via GitHub Pages
Prerequisites:
$ gem install jekyll bundler
Follow the steps to test it on your local browser.
- Clone this repository. 😄
$ git clone https://github.com/NIT-dgp/nit-dgp.github.io
-
Run
$ bundle installto install the dependencies. ( Grab a ☕ and 😎, cuz' it takes a while.) -
$ bundle exec jekyll serveto run the server. You're all set. -
Navigate to
http://localhost:4000/to view the site.
Create a new markdown file in /projects directory and add the appropriate
frontmatter to it.
layout: The layout to be used, it should always beproject.title: The title of the project.permalink: The absolute URL for the project.description: A clear description of what the project is aimed to do.logo(optional): A link(URI) to the project's logo, if any.gallery(optional): A collection inyamlconsisting of image objects, with the attributestitleandurl, describing the name and link to the image respectively.
File name should match frontmatter's title and permalink
eg:
---
layout: project
title: ExampleProject
permalink: /projects/ExampleProject
description: An example frontmatter for ExampleProject.
logo: https://example.com/cat-dog-image.png
gallery:
- title: "Fish"
url: "https://example.com/fish.png"
- title: "Cat"
url: "https://example.com/cat.png"
---
