Giter Club home page Giter Club logo

gh-pages-jekyll-site-template's Introduction

Github Pages Jekyll Site Template

This sample project contains all the building blocks of a basic site. Fill in your content and run jekyll serve --incremental to see it in the browser, or run jekyll build to create a post-compiled version in the docs/ folder.

Github Pages Setup

To build this site to Github pages, push it to a new repo and open the 'Settings' tab in the Github web UI. Configure the Github pages settings to use the docs/ folder of the master branch as detailed here: https://pages.github.com/

File / Directory Structure

_data/ - this directory contains files for rendering throughout. An Example is provided which works with navigation.html (in _includes/)

_layouts/ - this is the heart of the project, and contains the different page layout used

_includes/ - this folder contains chunk elements which can be pulled into page or post content. Navigation.html is provided as an example

_config.yaml - this is the core config file and handles things like the output directory, routing, and collection handling

_sass/ - place precompiled styles here

_posts/ - this directory will be parsed and rendered into new .html files

assets/ - this folder is for additional assets such as post-compiled styles, scripts, or images, and will be added directly to the build folder as is

docs/ - this project is designed for github pages, so we output all builds to the docs/ folder. Do not edit content in this folder as it will be overwritten when Jekyll runs

For more usage and general guidelines be sure to visit https://jekyllrb.com/

gh-pages-jekyll-site-template's People

Contributors

alexander-morris avatar

Watchers

 avatar  avatar

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.