jekyll-project-template

Write a tagline here!

By Your Name, Boston College

About

Put your project description here!

Files you need to edit

1. /_config.yml Put the title and general info for your project, and define what pages should appear in the nav bar
2. /_pages/ Add Markdown (.md) files for each page you defined in the _config.yml file (check out the Markdown Cheat Sheet)
3. /assets/img/ Put any images you want in your site here
4. /README.md (this file), to put your information and project description
5. CITATION.cff Edit this file to put in your information for automatical bibliographic citation generation on Github

Extra files to edit

1. /_sass/theme-settings.scss Edit this file to quickly change colors and fonts for the site. (Use this site to generate the hex color codes)
2. /_sass/custom-styles.scss Edit this file to put any custom CSS you want to style your site. (Learn basic css here)

Local Development

• Follow this guide to install Ruby and Jekyll
• Install Node
• git clone this repo and then cd inside the directory
• Comment out the url and baseurl lines of _config.yml when working locally
• Install Ruby dependencies by running bundle install
• Install Node dependencies by running npm install
• Run the server with bundle exec jekyll serve

Acknowledgements

Jekyll & Tailwind Setup based on TailPages by Harry Wang (Chinese: 王建楠)