Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
36 lines (25 sloc) 2.72 KB

Welcome to Historiography (HIST 491)!

This is our repository for submitting and accessing course work. Remember that you must be logged into GitHub to add files to the repository.

To post an assignment

All work must be submitted in Markdown. If you are new to Markdown, complete this Markdown tutorial. If you need syntax help, check out this cheat sheet.

There are three ways to post work here; please use whichever you find easiest or most convenient.

Writing on GitHub

  • Navigate to the appropriate assignment folder
  • Click on the "Create new file" button
  • Name your file appropriately (remember the .md extension)
  • Type your post into the text box
  • Commit your work with the green "Commit New File" button at the bottom
  • You can always edit your file after you commit it---click on your filename, then click the pencil icon. And don't forget to commit your changes (The green "Commit Changes" button at the bottom).

Writing somewhere else

If you write on GitHub (or anywhere online), it's not super convenient to save your work in progress (you can, but you have to click a few times to start editing again). Also, if you lose your internet connection while writing, you might lose your work because you won't be able to save it. Also, you can't see how your Markdown will render as you write it. There are two few easy options to avoid these issues:

Dillinger

If you want to write online and preview your Markdown text as you write, use Dillinger. It saves your work as you go. When you are done writing, you can get it into GitHub in two ways:

One is as described above (Writing on GitHub), but you'll simply copy and paste your text from Dillinger into the edit window on GitHub.

Or, you can:

  • Export your text as a Markdown file (which saves it to your computer)
  • Be sure your file is named appropriately
  • Navigate to the appropriate assignment folder
  • Drag and drop your file from your computer (wherever you have saved it, perhaps your downloads folder) to your browser window

Text Editor (highly recommended)

You can also write your text offline in a text editor. This way, you can more easily compose your assignment over a period of time, save it to your computer, and you will always have your own copy of your work. I recommend that you download and use the free text editor Atom. You can also preview your Markdown through the menu Packages->Markdown Preview->Toggle Preview.

When you are ready to post it on GitHub, save your file with an appropriate name (and .md extension), navigate on GitHub to the appropriate folder, and drag and drop your file. (same as above when exporting from Dillinger).

You can’t perform that action at this time.