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:
$ git clone [email protected]:gdiminneapolis/falling-in-love-with-git.git
$ cd falling-in-love-with-git
$ bundle install
$ yarn install
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.
@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.
$ 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.
$ 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.
agebhardt ? ? ? ? |
Tamara Temple ? ? ? ? ? ? ? ? ? |
|---|
This repo uses the all-contributors specification. There is a tool to make it easy to add people to the list.
This will require the contributor's GitHub account name, e.g. tamouse.
$ yarn contributors:add
.all_contributors file:$ yarn contributors:generate
Make sure to read the all-contributors specification before you update it manually.