Customizing the site

The EDD library site is built using Jekyll and hosted with GitHub Pages. Jekyll is a pretty sweet static site generator.

To run the library site locally, you'll need to:

1. ⬇️ Checkout the repo
2. 💾 Install Jekyll
3. 🏃 Run bundle exec jekyll serve to enable the build process which will stay running until you stop it
4. 🕸 Navigate to http://localhost:4000 to view your Jekyll site

That sounds easy but was actually a royal pain on my first few attempts. I absolutely always have obnoxious issues with Ruby being out of date or some gems being missing or something stupid 😡 . If the very concise Jekyll docs and a few Google searches can't get you up and running, ping Kyle and maybe you'll be able to work it out together 🤝 .

Once you're running, you'll notice that there's a _site directory in your local project. Those are the compiled files which your site is running. Don't touch them.

CSS changes

The site uses SASS 😎 so all you really need to do is edit the main.scss file in the assets directory. If Jekyll is running, it will build the files as you save. Please leave comments with your changes.

Template changes

At this time, there are some templates which might need edits. They are as follows:

• layouts/snippet.html - This controls how individual snippets are displayed.
• Everything in includes (footer.html, header.html, etc.) - Structural files used globally on every page.
• Everything in _pages - These are the top-level pages for all the snippet categories.
• index.html - The file for the home page.

Content changes

At this time, the only page with real content which could use updating is the home page which is the index.html file in the root directory. Besides that, there are the actual snippets which can also be edited by finding the category folder (which will be prefixed with "_") and then editing the appropriate HTML file within that. Do not edit anything in the _site directory.

Here is a picture of what the local file structure should look like: