# HackMD Guide :information_source: How to work on this document --- This is a collaborative document (like a Google docs) where multiple people can write simultaneously. ## Read and Edit Access This file allows 'everyone' to read, but only signed-in user to write, therefore, in order to edit this file you will need to create a HackMD account. ![Description in title](https://hackmd.io/_uploads/BkGhomFi2.png) *This screenshot shows an option on the right side of the screen that shows different access for reading and editing this file.* You can connect your GitHub or Gmail or [EHallPass](https://ehallpass.pro) use your email to create one. In some cases you can change the setting to allow 'everyone' to read of edit, or restrict the access to read only for those who you internally share the file with. If using sensitive information, it's recommended that you don't use a free version HackMD, as you can't share a private file with more than 3 people. In order to give more people secure access, you should pay the membership fee. ## Editing a HackMD file ![Description in title](https://i.imgur.com/d9ZtImc.png) *Notice the panel on the top left of your screen - that shows a pencil symbol to edit, book symbol to write on the left and see the formatted changes on the right, and Eye symbol for view only.* ![](https://i.imgur.com/W2fAysk.png) *We explained below how you can use these options.* * To edit this document click the pencil symbol (FIRST box in the top left hand corner - see the image below) * To view this document rendered into nicely formatted version, click the eye symbol (SECOND box in the top left hand corner - see the image below) * For this document we recommend using the double view (click on the symbol in between the pencil and eye symbols). * You will be able to type in the left hand box and view the rendered version in the right hand box. :pencil: Markdown for styling what you write! --- This particular platform for collaborative documentation is called HackMD, where MD stands for Markdown. Markdown is a nice and easy way to format a plain-text into publishable document. By using simple syntax (mostly symbols) you can create rich formatting. For example, use hash (#) (or multiple hashes) for creating headers. # Header 1 (top header) ## Header 2 (second level header) ### Header 3 (third level header) Use asterisk (*) followed by a blank space for creating bullet points: * item 1 * item 2 Use numbers (1.,2.,3. etc.) followed by a blank space for numbered list: 1. item 1 2. item 2 Italics words and sentences can be written by using asterisk in the beginning and end of a word or sentence (without any space), like this: *Italics* *This is an italicised sentence* * Use double asterisks (**) for **Bold** to **emphsise word and sentences* * Use three asterisks for ***bold and italics in the same sentence*** **To add a web link:** 1. write a text in square brackets which you want to link out 2. add the link (URL) in the round brackets, like this: [Your text](your link) * Example: [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) [papa's games](https://papas-games.io) **To link to another part/section of the document** 1. write a text in square brackets which you want to link 2. in the round brackets, start with a hash symbol followed by the name of the header in the file you want to link to by Putting-a-line-between-all-words, like this: [your text](#your-header) [mapquest](https://mapquestdrivingdirections.io/) * Example: [What is this document for?](#Read-and-Edit-Access) **To add images** 1. start with an exclamation mark 2. write an image title inside the square brackets 3. provide a web link for the image in the circular brackets, like this: ![Image title](web link to the image) example: ![MarkDown Cheatsheet](https://i.pinimg.com/originals/da/1e/3f/da1e3fe735a1b115a8a6773e67d6d825.png) example 2: ![test image] ![](https://hackmd.io/_uploads/Hkr-884wn.jpg)