Skip to content

Instantly share code, notes, and snippets.

@vcolavin
Last active July 16, 2018 23:28
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save vcolavin/3a6db5dd34815d28898521d3197c2aac to your computer and use it in GitHub Desktop.
Save vcolavin/3a6db5dd34815d28898521d3197c2aac to your computer and use it in GitHub Desktop.
A cheatsheet for Periscopic's content authors writing Markdown

Author guide for Article and Project body copy

Click the "raw" button at the top-right of this box to see the unrendered (aka "raw") version of this guide. Some of this guide will only make sense if you also see the "raw" view, so try and view these side by side.

You may also find it helpful to look at the Example Project.

For the most part, you'll be using Markdown. It provides a nice syntax for things like headers, bulleted lists, and links.

Markdown is not a "What You See Is What You Get" format. Because of this, I recommend that you write your post in a markdown editor, then paste it into the body field of the Project or Article. It will make your life easier.

Here are some good browser-based markdown editors:

Example usage:

This is a secondary header

And this is a tertiary header. You probably won't use this much.

this is how you do italics

and this is how you do bold

and this is bold italics

this is how you do a block quote. It can be on one line or on many lines.

  1. this is an
  2. ordered list
  • this is an
  • unordered list

this is how you do in-line code snippets

this is how you do code blocks

getting asset URLs for videos, images, and downloads

  • visit the "media" page on the sidebar
  • either upload or select the thing you want
  • get the item's URL from its details page

Note: Some file types (e.g. .json) will not upload. This is because of Wordpress's security settings, and we can to whitelist that file type. Contact a developer if this happens.

Differences from normal Markdown:

Markdown doesn't do everything we need, though. We want to be able to put information in a sidebar. We want images to have captions appear to the right. We want some hyperlinks to have equivalent buttons in the sidebar, with text.

this is a plain in-line link

Link: case study

this is a case study link {.case}

Link: article

this is an article link {.article}

Link: press

this is a press link {.press}

Link: download

this is a download link {.download}

Image: full

this is alt text for an image which extends into the left margin{.full}

Image: artwork

this is alt text for an image which stays within the margins

Image: caption

this is the caption to the right of the image above {.caption}

Video: (this one is different) <video src='example.com/my-video.mp4'/>

Blockquote with caption

This is A blockquote it is long blah blah blah blockquotes

and this is a citation for the blockquote {.citation}

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