What’s that? How does it work?

What is HedgeDoc?

For some, perhaps known just as pad, it is a way to write something down together in realtime. HedgeDoc in particular uses Markdown as syntax. What does this mean? The text looks pretty much the same and it is easier than writing LaTeX. And if you’re taking CgDA right now, you already know this from the Jupyter notebooks.

How does HedgeDoc work?

  • Create a Pad
    Just click on the small pad icon on the main page of the platform or if you are already writing a pad, click on the ‘+New’ in the upper right corner.

  • Invite others to write along
    Just copy the link in your browser and send it. Anyone who clicks on it can take notes.

  • Help, I can’t write anything
    HedgeDoc supports different modes, which are shown in the upper left corner. View, Both and Edit (Eye, 2Tabs, Pen), where the Both mode is only visible on desktop and tablet and not mobile. If you can’t write anything, you are probably on View. Click on one of the other icons and you should be able to write in the darker area.

  • A persistant Pad
    Once you have created a Pad, you can also close it in the browser and reopen it with the link. So you can write on the same document on several dates.

  • Export your document
    Click on the ‘Publish’ icon in the top right corner to get it as an html file which you can print as a PDF, or choose from the ‘Menu’ (also in the top right corner) how you want to download it. We also host a web service, that uses Pandoc to export pads form our site as PDF. This has the advantage, that the PDF actually gets compiled by LaTeX and therefore usually looks a bit more professional. Try it out here.

  • Upload images
    Either simply drag and drop the file in, or click on the Upload button (from above the symbol with the arrow pointing upwards), or copy and paste.

  • Write your old Markdown document here
    Just click on the Upload button (from above the symbol with the arrow pointing upwards) or copy and paste.

  • How do I make it look beautiful?
    If Markdown tells you something (and you can handle it), use this and it will look good. If not, as always, “Google helps” applies. But here are a few commands to get you started, which will help to make it look better:

    1. # at the beginning of a line: Heading, the number of # identifies the ‘heading rank’.
    2. \(\int_{-\infty}^{\infty}\) since formulas are beautiful and we want to have an integral like this and not otherwise, you can easily get into latex mode with the dollar sign ($...$ or $$...$$) and write formulas with normal latex syntax
    3. bold by writing: __bold__ or **bold**.
    4. Italic by writing: _italic_ or *italic*

  • Additional notes:\