Skip to content

FRC-1123/frc-1123.github.io

Repository files navigation

This is AIM Robotics' (FRC Team 1123) team website, written with Jekyll and Materialize.

Updating Members

Member information is located in the current_members.yml and past_members.yml YAML data files (under _data/). YAML is very human-readable, so it shouldn't be very hard to figure out the format. Add member pictures under assets/img/members/.

Contributing

Requirements

  • GNU/Linux, Unix, or macOS
  • Ruby version 2.0 or above, including all development headers
  • RubyGems
  • GCC and Make

Local Setup

Install Jekyll and Bundler by running gem install jekyll bundler. After forking this repository, cd into the root of the repository and run bundle install. To start a local development server on port 4000, run jekyll serve, or run jekyll serve -I to allow incremental builds (significantly faster builds, but might break). See the Jekyll documentation for more details.

Creating Posts

The jekyll-admin plugin, which is installed when you run bundle install, allows you to make posts very easily through a browser. With a development server running, go to localhost:4000/admin to access the admin interface. Go to "Posts" and press "New Post". After writing your post, scroll to the bottom and add the following metadata fields:

  • author
  • tags (optional)

If you want to add tags to your post, make sure to press "Convert to List" under the dropdown menu. When you're done, press the "Create" button. (If you get an error that says "Could not update the doc," just ignore it.) You can then go back to the "Posts" tab, click on your post, and press "View" to make sure it looks right. Once you're happy with your post, make a commit and submit a pull request on GitHub.

Note on Contributing

Please make sure that the website remains responsive (i.e. fast and mobile-friendly)! :) Materialize's grid system is really helpful for this.


Questions, comments, or feature requests? Email me at [email protected].