Giter Club home page Giter Club logo

jekyll-test's Introduction

Agency Jekyll Theme | Preview

This is the Agency Bootstrap theme converted to a gem-based Jekyll theme with GitHub Pages support. Thanks to raviriley, we can have new features that go beyond the original theme's capabilities:

  • GitHub Pages support
  • contact form functionality powered by Formspree.io
  • custom pages
  • 404 page
  • legal/Privacy Policy page
  • Google Analytics support
  • Markdown support
  • custom images
  • logo support (instead of just title text)
  • automatically updating copyright years
  • custom navigation bar, even without the header image(s)
  • customizable footer
  • custom accent color and dark/light colors
  • horizontal scrolling support for client section

The Jekyll structure of this theme includes:

  • _portfolio files - what generate the portfolio grid. YAML front matter handles all the details
  • page layout allows custom pages, as seen in the legal and 404 pages
  • sitetext.yml enables complete customization of all site text
  • navigation.yml enables fully customizable navigation
  • style.yml enables fully customizable colors, background images, and other style-related things

Installation

1. Install Jekyll

Follow the tutorial to install Ruby and Jekyll.

2. Clone the repo

To set up your environment to develop this theme, clone this repo:

git clone https://github.com/zixuan96/jekyll-test.git

Development

Enter the folder then run

bundle install

To test the theme, run

bundle exec jekyll serve

and open your browser at http://localhost:4000.

Add pages, documents, data, etc. like normal to test the theme's contents. As you make modifications, your site will regenerate and you should see the changes in the browser after a refresh.

Possible problems

If you face the problems in executing bundle exec jekyll serve, try to execute

bundle add webrick

and then rebuild it.

License

The theme is available as open source under the terms of the MIT License.

jekyll-test's People

Contributors

raviriley avatar zixuan96 avatar dependabot[bot] avatar shou1dwe avatar bheithaus avatar xsuchy avatar morozgrafix avatar

Watchers

James Cloos 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.