Skip to content

Instantly share code, notes, and snippets.

@shduff
Last active November 30, 2018 20:20
Show Gist options
  • Save shduff/6149539ba7beeea49be7f7958d4ba7a2 to your computer and use it in GitHub Desktop.
Save shduff/6149539ba7beeea49be7f7958d4ba7a2 to your computer and use it in GitHub Desktop.

Hey! This is a quick template for how to make your Plinkquito documentation pieces.

Write your piece out in markdown in a github gist. This gist is written to act as a template to get you familiar with Markdown. You can Fork it into your own github account using the fork button in the upper right of the page and then edit it from there to play around with how things look.

When you're ready, create your own gist for your Plinkquito piece. When you're done, save your gist and click the "raw" button in the upper right of the document.

This should take you to an ugly looking page, and ugly is good. Paste the link to that page in the "link" column of this spreadsheet along with all the other metadata about your piece.

Let me know if you have any questions, and here are some markdown basics to get you started!


This is what a big heading looks like. It needs that single number sign.

Italics need this single star

Be sure you add a ".md" at the end of your title, as that will make this text editor start to highlight your text in useful ways as you write it.


^ Those three lines add a horizontal line, and these two stars make something bold.

You can also have different levels of headings.

Same as in google docs or wherever.

If you want to embed some media—a video or scratch project or something—just copy and past the embed code from its website. For example:

<iframe width="560" height="315" src="https://www.youtube.com/embed/Ah0Ys50CqO8" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

Or:

<iframe class="scratch" src="https://scratch.mit.edu/projects/embed/261765842/"></iframe>

These won't show up in the gist, but they'll work on our site.

You can also make links like this:

LINKED TEXT

And lists like this:

  • bullets get made
  • with lots of different things
  • whatever you prefer

And ordered lists are similar:

  1. but the weird thing is
  2. it doesn't matter if your numbers
  3. are in order in your code
  4. they're in order when they're viewed!

You can also embed a photo like this, just like a link but with an exclamation at the front of the line:

some alternative text for the photo in case it doesn't load

Make sure the link you put in a photo tag goes DIRECTLY to an image, like... ends iwth .jpg or .png or .whatever, otherwise it won't load!

If you indent, something will show up nicely as a quote.

Those are some of the most useful things in Markdown. But, know that you can also drop in any html code you want. Just FYI

Thanks for creating your pieces here!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment