Permalink
Branch: master
Find file Copy path
63537c5 Jan 9, 2019
1 contributor

Users who have contributed to this file

118 lines (75 sloc) 2.91 KB
title lastmod publishdate author draft description
Style Guide
2019-01-06 06:14:45 -0700
2019-01-06 06:14:45 -0700
Jeff Delaney
false
Style Guide for Contributing Content to Fireship.io

This guide is for authors and developers who contribute content to Fireship.io.

Things to Know

Here are a few tips to keep in mind before working on this project:

  • Feel free to pull request typos or obvious minor fixes (no issues or discussion necessary).
  • Discuss your article ideas on Slack first.
  • Content is managed with Hugo and located under hugo/content.
  • If you contribute I want to make it worth-your-while (see tier below)

Contribution Tier

I like to give away things you can hold in your hand. Here's what you can expect:

  • Small fixes or typos === 🔥 Sticker.
  • Guest post or major code improvements === 👕 T-shirt.
  • Course collaboration === 💰 Paid freelance job or revenue share.

How to Fix, Improve, and Create Content via Github

First, fork the main repo on github, then clone it to your local machine. You must have Hugo and Node installed.

{{< file "terminal" "command line" >}} {{< highlight terminal >}} git clone npm install npm run dev

git checkout -b my-fix {{< /highlight >}}

After making your fix or adding new content, submit a pull request on github.

{{< file "terminal" "command line" >}} {{< highlight terminal >}} git commit -m "fix: corrected a typo" git push origin my-fix {{< /highlight >}}

Writing in Markdown

Content is written in markdown. Posts should only use h2 and h3 tags.

{{< file "md" "some-cool-post.md" >}} {{< highlight markdown >}}

Step 1: Do Something

some overview text

Specific Details

link to somewhere useful

{{< /highlight >}}

Images for lessons are saved in the relative image dir, lessons/<lesson>/img/ and use the Hugo figure shortcode.

{{< file "md" "some-cool-post.md" >}} {{< highlight mardown >}} {{</* figure src="img/my-images.png" alt="cool image" */>}} {{< /highlight >}}

Code snippets use Hugo shortcodes. Optionally, you can give the code block a icon and filename. The available icons are listed in the layouts/partials/svg dir.

{{< file "md" "some-cool-post.md" >}} {{< highlight mardown >}}

{{</* file "ngts" "index.ts" />}} {{</ highlight typescript */>}}

console.log('hello')

{{</* /highlight */>}}

{{< /highlight >}}

Note: Angular specific icons are prefixed the ng.

Add Contributor Bio

Thank you for contributing 🙏. Make sure you add details to the contributors section and save your avatar image to the static/img dir.

{{< file "md" "michael-jordan.md" >}} {{< highlight mardown >}}

title: Michael Jordan draft: false

featured_img: /img/contributors/your-avatar.png

youtube: linkedin: medium: twitter: github: portfolio:

I used to play baseball...

{{< /highlight >}}