Editing

This document describes techniques for editing the various types of files during various stages of a project.

Markdown

Markdown is a a markup language that makes it easy to create nice looking documents in and ascii editor. This is the language that we are using on the wikis for documentation, and generally for any text documents on the NuGrid github organzation. Markdown is also the dialect that text cells in ipython notebooks are written in. So, markdown is really an essential skill.

Examples and tutorials

• there are lots of online tutorials:
  • http://www.markdowntutorial.com
  • https://guides.github.com/features/mastering-markdown
• transform markdown into other formats: Pandoc

Markdown editors

Mac

• MacDown

Linux/Windows

• Remarkable
• ReText

Windows

• no good alternatives here?