Use Markdown

What Markdown is for

Markdown files are lightweight text documents that can include headings, lists, links, images, code blocks, math, and mentions. Use them for README files, notes, lab instructions, project documentation, and content that should remain easy to edit as plain text.

Edit Markdown

Open a .md file in a project. CoCalc can show a source editor, a rendered preview, and rich text editing surfaces depending on the file and view. Use the source view when exact Markdown syntax matters, and use the rendered view when you want to inspect the final document.

Use code and math

Fence code blocks with triple backticks and include a language name when useful. Use Markdown math syntax for formulas. Keep long generated output in separate files or notebooks instead of pasting it into prose.

Mentions and collaboration

Markdown is collaborative in CoCalc. Use mentions when you want to draw a collaborator into a specific discussion or document context, and keep durable instructions in files instead of only in chat.