/gigs-template

Use this repository as a template to get started with gigsboat and events tracking

Primary LanguageCSSApache License 2.0Apache-2.0

Welcome to your new place on the web where all of your speaking engagements are tracked 🎉

How to get started?

  1. Hit the green button on the top-right that says Use this template and create your own repository out of this one.
  2. In your new repository, create a new file of your recent speaking activity. There's an example file at pages/2021/2021-01-01.md to give you an idea of the format, and structure. If in doubt, head over to the gigsboat CLI repository for even more information.
  3. Update gigsboat.json so that markdownFile config option is set to README.md.
  4. Commit the file changes, and push to the main branch. Every time you make changes that merge into the main branch, a GitHub Actions workflow executes, parses all the data files under the pages directory, and commits to the repository a newly generated README.md file. The workflow will also create a folder jekyll that will contain the right files for the GH Pages to be deployed from the root of your repo (you don't need to explicitly set the GH Pages to point to the docs folder).