Skip to content
JavaScript CSS HTML Ruby Shell
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_includes
_js
_layouts
_sass
assets
script
.babelrc
.eslintignore
.eslintrc
.gitignore
.scss-lint.yml
.travis.yml
404.md
CNAME
Gemfile
LICENSE.txt
README.md
_config.yml
ballot.md
gulpfile.babel.js
index.md
jekyll-sleek.gemspec
locations.md
package-lock.json
package.json
register.md
sleek.jpg
sw.js

README.md

Vote, CLT!

"Vote, CLT!" is a website built by the community to help drive voter education and engagement.

To contribute information to this website or resolve inaccuracies, please submit an issue ticket or pull request.

Contributing

Development

Clone the repo and git checkout the develop branch. master is reserved for GitHub Pages deployments.

You'll need Ruby, Jekyll, and Node set up on your development machine.

Edit the homepage at _layouts/default.html.

The pages are generated by markdown files: ballot.md, locations.md, and register.md.

Run the site locally using npm start. That should build the assets and serve the site locally on port 3000.


Original Template Notes Below

Sleek

Installation

System Requirements

To use this project, you'll need the following things on your local machine:

Jekyll

gem install jekyll

NodeJS (8 or greater)

Download and open the NodeJS installer

Gulp CLI (optional, but recommended)

npm install --global gulp-cli

Up & Running

  1. Fork the repo
  2. Clone or download the repo into directory of your choice: git clone https://github.com/your-github-username/sleek.git
  3. Inside the directory run bundle install and npm install
  4. If you want to use gulp.js run gulp or npm start
    • if you don't want to use gulp you can run bundle exec jekyll serve instead

File Structure Overview

sleek
├── _includes	               # theme includes
├── _js	                       # javascript files (by default jquery will be included with the scripts inside)
├── _layouts                   # theme layouts (see below for details)
├── _pages                     # pages folder (empty by default)
├── _sass                      # Sass partials
├── assets
|  ├── css	               # minified css files
|  ├── img                     # images and icons used for the template
|  └── js		               # bundled and minified files from _js folder
├── _config.yml                # sample configuration
├── gulpfile.js                # gulp tasks (tasks autorunner)
├── index.md                   # sample home page (blog page)
└── package.json               # gulp tasks

Pages

The home page is located under index.md file. To change the content or design you have to edit the default.html file in _layouts folder.

In order to add a new page, create a new html or markdown file under root directory or inside _pages folder. To add a link in navigation add it in _config.yml:

# THEME SETTINGS
navigation: # Navigation links
  - {name: 'Home', link: '/'}
  - {name: 'About', link: '/about'}
  - {name: 'Contact', link: '/contact'}

name is the text that will be shown and link, well, it's a link.

Development

To set up your environment to develop this theme, run bundle install and npm install.

The theme is setup just like a normal Jekyll site! Check out file structure overview for details. To test the theme, run gulp and open your browser at http://localhost:3000. This starts a Jekyll server using the theme. Add pages, documents, data, etc. like normal to test the theme's contents. As you make modifications to the theme and to the content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.

License

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

You can’t perform that action at this time.