Skip to content
This repository has been archived by the owner on Aug 7, 2023. It is now read-only.

Latest commit

 

History

History
116 lines (74 loc) · 3.45 KB

README.md

File metadata and controls

116 lines (74 loc) · 3.45 KB
Raw

Git Workshop Materials

This repository contains the source code for Git workshop materials.

Development

Dependencies

  • git: The version control system which is used for this project
  • Hugo: The static site generator used to build the website
  • Any text editor (e.g. VS Code, Atom, or Notepad++)

Getting started

git clone --recurse [email protected]:ePages-de/git-workshop.git

Content authoring

Tutorials

Add a new tutorial

Run the following command to add a new presentation in Hugo's content directory:

hugo new --kind tutorial subject-two/my-tutorial

Content syntax

The presentations can be created using Markdown syntax.

Content syntax extensions

Along with the Markdown syntax, you can use the following custom Hugo shortcodes:

Info callout box

{{< info >}}
Lorem [impsum](https://example.com) dolor sit amet.
{{< /info >}}

Tip callout box

{{< tip >}}
Lorem [impsum](https://example.com) dolor sit amet.
{{< /tip >}}

Warning callout box

{{< warning >}}
Lorem [impsum](https://example.com) dolor sit amet.
{{< /warning >}}

Presentations

The presentations are authored with the help of plain HTML code for reveal.js content elements.

Add a new presentation

Run the following command to create a new presentation in Hugo's content directory:

hugo new --kind presentation subject-two/my-presentation

Preview changes

To a development server that always re-renders after every change, run the following command:

hugo server

Maintenance

This section is only relevant for project maintainers.

Update theme

If you want to apply a new version of the workshop-materials project where the layout of the website is defined, execute the following command:

cd themes/workshop-materials/
git pull origin master
cd -
git add themes/workshop-materials/
git commit -m "Update theme"

Publish website

To publish the website, just do a new commit on the main branch of the upstream repository. The GitHub Action hugo.yml will generate the HTML code and publish it on the gh-pages branch from which the website is hosted.

Credits

  • The layout of the start page and the subject list pages is applied from a Bootstrap template by Xiaoying Riley which is licensed under Creative Commons Attribution 3.0 License.
  • The layout of the tutorial pages is inspired by Google Codelabs.
  • The presentations are based on RevealJS which is licensed under the MIT license.
  • At various places of the website Font Awesome icons are used.

Copyright

(c) ePages 2021 and CONTRIBUTORS.

Except as otherwise noted, the content of this repository is licensed under the Creative Commons Attribution 3.0 License.