HackMD

← Back to Research Lab

Summary. HackMD is a browser-based, real-time collaborative Markdown editor — think Google Docs, but for Markdown. In the lab we use it for meeting notes, shared reading notes, quick documentation, and drafting before moving text into a paper or report. Everything is written in Markdown, so it exports cleanly and supports code blocks and LaTeX math.

Website: https://hackmd.io

Prerequisites

• A modern web browser (no install needed).
• A free HackMD account — sign up at https://hackmd.io (you can log in with Google, GitHub, or email).
• (Optional) Ask a lab member to add you to the lab’s HackMD team/workspace so shared notes appear in one place.

Getting Started

1. Go to https://hackmd.io and sign in.
2. Click New note (or +) to create a note.
3. Write in Markdown on the left; the rendered preview updates on the right. Use the top toggle to switch edit / both / view modes.
4. The first # Heading becomes the note’s title.
5. Click Share (top right) to copy the link, then send it to collaborators.

Useful Markdown that works in HackMD:

# Title
- bullet list
1. numbered list

`inline code`  and fenced blocks:
```python
print("hello")
```

Math: $E = mc^2$   and block math with $$ ... $$

> quote        | table | col |
                |-------|-----|
                | a     | b   |

Collaboration

• Real-time editing: multiple people can type in the same note at once; you’ll see their cursors.
• Permissions: open the ⋯ menu → Sharing / Permissions to set who can read vs. write (Owner / Signed-in / Everyone). Restrict “write” to your team for shared docs.
• Comments: highlight text to leave a comment for discussion.
• Team workspace: notes created in a team are visible to all team members — the tidiest way to keep lab notes together.
• Version history: the ⋯ menu → Revision lets you view and restore earlier versions.

Tips & Troubleshooting

• Slides: change the note type to Slide mode to present directly from a note.
• Export: ⋯ menu → Export to Markdown, or print to PDF from view mode.
• Publish: ⋯ menu → Publish creates a clean read-only public link.
• Can’t edit someone’s note? You likely have read-only permission — ask the owner to grant write access, or duplicate the note.
• Math not rendering? Use single $...$ for inline and $$...$$ on their own lines for block math.

References

• HackMD: https://hackmd.io
• Documentation: https://hackmd.io/@docs
• Markdown & features guide: https://hackmd.io/@docs/features