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

Preparing Markdown Files (for DH assignment solution pages)

Elisa Beshero-Bondar edited this page Sep 29, 2015 · 2 revisions
  • How to write Markdown for GitHub
  • Please write and save solution files in markdown, with a .md file extension. Use the tick-mark ` to set off spans of code or regular expressions. The code "tick" can be used really to highlight any code text we want to call attention to, even if it's not strictly necessary for screen rendering a passage of coded text (as in a regex).
  • Remember, we don't want to push solution pages here to GitHub until it's the right time for students to view them, and they'll be posted to the DHClass-Hub.
  • But we want to be able to preview files we write in Markdown (or .md). To do that offline, we recommend installing a Chrome extension that permits viewing Markdown in pages online or offline after you edit your Chrome plugin settings to permit viewing local files this way. To do enable Markdown previewing, try this free plugin, Markdown Preview Plus
  • After you install Markdown Preview Plus, go to your Chrome Extensions settings by pasting this into your Chrome browser: chrome://extensions/ Find the Markdown Preview Plus extension on the alphabetized list of extensions and browser plugins, and click on the checkbox next to "Allow access to file URLs."
Clone this wiki locally