flashman
← All guides

Markdown writing guide: syntax, preview, and export

Learn Markdown basics — headings, lists, code blocks, tables — and how to preview or export to PDF in your browser.

2026-06-02 · 7 min read

Markdown is a lightweight markup language for README files, docs, notes, and blog drafts. You write plain text with simple symbols; tools render it as HTML. Because Flashman processes Markdown locally, drafts and sensitive notes never leave your device.

Core syntax

Most platforms (GitHub, GitLab, Notion exports) support GitHub Flavored Markdown (GFM), which adds tables and task lists.

  • # Heading 1 and ## Heading 2
  • **bold** and *italic*
  • `inline code` and fenced ```code blocks```
  • - bullet lists and 1. numbered lists
  • [link text](https://example.com)
  • > blockquotes for callouts

Tables

Use pipe characters for columns. A header row followed by a separator row of dashes defines alignment:

  • | Column A | Column B |
  • |----------|----------|
  • | Value 1 | Value 2 |

When to use each Flashman tool

The Markdown editor is best for writing with live split preview and copying HTML. The viewer opens local .md files for reading. Markdown to PDF exports a print-ready document for stakeholders who do not use Markdown.

  • Editor — draft READMEs and copy sanitized HTML
  • Viewer — open .md files from disk without uploading
  • PDF export — share specs or notes as a downloadable PDF

Tips for clean docs

Keep lines under ~100 characters when humans edit the file. Use fenced code blocks with a language tag for syntax highlighting. Preview before publishing — rendering can differ slightly between platforms.

Try these tools