Skip to content

gdiminneapolis/falling-in-love-with-git

Repository files navigation

Course slides for 'Falling in Love with Git' GDI Minneapolis Course

All Contributors

Resources

Contributing

We are always looking for help in improving our training materials. We'd like your participation as well!

First, read the Contributor Covenant.

Next, you can contribute in the following ways:

  • Submit an problem, suggestion, or question via Issues
  • Write or update a page explaining something on the project Wiki
  • Fork and clone the repo, cut a branch, make your changes, and submit a Pull Request

Prerequisites

  • Install Jekyll (which requires Ruby)
  • Install node, latest v8 LTS stable is fine
  • Install yarn, latest stable
  • Understand how reveal presentations work

Download

$ git clone [email protected]:gdiminneapolis/falling-in-love-with-git.git
$ cd falling-in-love-with-git

Initialize

$ bundle install
$ yarn install

Editing

The main place you'll want to make changes will be to the source/_slides/ files. Each file contains a portion of the presentation. Following the conventions for reveal slide decks, each file is a <section>, which go from left to right. If you embed sub <section>s inside, those slides will go down.

You can use either HTML or MarkDown, which ever suits your needs the best.

Styles

@agebhardt created several custom styles created for this presentation. Pay attention to how they are used, study the file source/css/styles.css to learn their secrets and awesomesauce.

Additionally, since this is a reveal-based presentation, you should study those styles as well.

Viewing slides while editing

$ yarn start

Will launch your default browser in a live-update mode looking at the generated jekyll directory, and watch the jekyll source directory for changes. Note the first time you run this, there might not be a _site folder, so you may need to refresh the browser after the first build completes.

Publishing to Github Pages

$ yarn checkin

This will create the docs/ directory which is where the slides will be served from, commit and push all the current changes to the public repository.

The file _publish.yml in the root directory can be set to provide overrides and fill-ins needed for publishing on GH pages. Generally speaking, nothing needs to be done with these settings.

Contributors


agebhardt

💬 💻 🎨 📋 💡 🤔 📢

Tamara Temple

💬 📝 🐛 💻 🎨 📖 📋 💡 🤔 🚇 📦 🔌 👀 📢 ⚠️ 🔧

Updating Contributors List

This repo uses the all-contributors specification. There is a tool to make it easy to add people to the list.

adding a new contributor:

This will require the contributor's GitHub account name, e.g. tamouse.

$ yarn contributors:add

generating a new version after manually editing .all_contributors file:

$ yarn contributors:generate

Make sure to read the all-contributors specification before you update it manually.