rva.codeforamerica.org is running on Github pages, which are powered by Jekyll. Below are some How-to's and extra information for installation, editing the site, and making new pages.
Install & running Jekyll
Jekyll can be installed on your computer following these instructions from @codeforamerica
Once installed successfully, cd into your project directory and run jekyll serve --watch which will make your site available at localhost:4000 and continue to watch for changing files. *Note: if you are changing information in the _config.yml you will need to rebuild the site by canceling the current process and re-running it.
Site Architecture
Jekyll uses the _ for all of the "working" directories, such as _includes/. These are modular files that are used in the _layouts/ directory. You'll see a _site directory on your computer (not followed by .gitignore) and that is technically where the static HTML is generated by Jekyll.
We have two "layouts" currently, home.html and default.html. Home is a unique one for two reasons:
we currently don't use the _includes/footer.html file since it is not in the design, and
there is a loop that looks through all the pages and their weight (see below) to order in the list. Currently we only have February Reflections
Pages, current and new
All of the pages are accessed in their own directory. For example, our February Reflections page is located in the february/ directory (where the URL name comes from). This directory includes an index.html page, just like any HTML structure.
Each index page, you'll notice, has a bit of YAML at the top to designate specific information for jekyll to build properly. Our pages have four pieces:
---
layout: default #specifies the layout for this page to use
title: February Reflections #name of the page, used on homepage
weight: 1 #weight designates the order in which to grab this page in a loop
header_img: 'header_murals_innerglow2.jpg' #header image to use
---
Adding a new page
Add a new page by creating a new root-level directory and adding an index.html file with the YAML at the top.
Why aren't we using _posts functionality?
Right now we're not really blogging. Also, the _posts feature is particularly useful when writing in markdown, but our site currently has a design that makes using markdown difficult (i.e. <aside>, <figure>, and combination of full-width images and containers) because of some needed HTML characters that aren't available in markdown syntax.
rva.codeforamerica.org is running on Github pages, which are powered by Jekyll. Below are some How-to's and extra information for installation, editing the site, and making new pages.
Install & running Jekyll
Jekyll can be installed on your computer following these instructions from @codeforamerica
Once installed successfully,
cdinto your project directory and runjekyll serve --watchwhich will make your site available atlocalhost:4000and continue to watch for changing files. *Note: if you are changing information in the_config.ymlyou will need to rebuild the site by canceling the current process and re-running it.Site Architecture
Jekyll uses the
_for all of the "working" directories, such as_includes/. These are modular files that are used in the_layouts/directory. You'll see a_sitedirectory on your computer (not followed by.gitignore) and that is technically where the static HTML is generated by Jekyll.We have two "layouts" currently,
home.htmlanddefault.html. Home is a unique one for two reasons:_includes/footer.htmlfile since it is not in the design, andweight(see below) to order in the list. Currently we only have February ReflectionsPages, current and new
All of the pages are accessed in their own directory. For example, our February Reflections page is located in the
february/directory (where the URL name comes from). This directory includes anindex.htmlpage, just like any HTML structure.Each
indexpage, you'll notice, has a bit of YAML at the top to designate specific information for jekyll to build properly. Our pages have four pieces:Adding a new page Add a new page by creating a new root-level directory and adding an
index.htmlfile with theYAMLat the top.Why aren't we using
_postsfunctionality?Right now we're not really blogging. Also, the
_postsfeature is particularly useful when writing in markdown, but our site currently has a design that makes using markdown difficult (i.e.<aside>,<figure>, and combination of full-width images and containers) because of some needed HTML characters that aren't available in markdown syntax.