Browse documentation

Start here

What is a Markdown file?

A small amount of syntax. A document you can take anywhere.

On this page

YOU WRITE

# A little room to think

YOU SEE

A little room to think

A # followed by a space creates the main heading.

Same words. A little structure makes the difference.

Start with plain text

A Markdown file is a text document with simple marks that describe its structure. A # introduces a heading. A pair of ** marks makes words bold. The file usually ends in .md or .markdown.

The marks are ordinary characters, so you can read and edit the file in a plain-text editor. A Markdown renderer turns those characters into headings, lists, links and other formatted content. In editmd, Split shows the source and the rendered result together.

Why use it?

Markdown keeps the writing separate from a particular app. Your text stays readable, is easy to copy or search, and can be kept alongside related files. You can start a document in editmd and open it in another Markdown editor later.

It is especially useful when the structure matters more than precise page layout. A designed brochure or a document that needs exact page breaks may be better finished in a page-layout or word-processing app.

Where you will find it

Use A typical file Why Markdown fits
Personal notes ideas.md Quick to write and easy to keep in folders.
Project documentation README.md Explains what a project is and how to use it.
Meeting notes planning.md Headings, decisions and task lists in one readable file.
Website content article.md Many publishing tools turn Markdown into web pages.
Technical writing guide.md Code, links and prose can live together.

A file is not a website

Saving a Markdown document does not publish it or send it to anyone. A website, repository or sharing service must receive the file before other people can read it. editmd saves to the location you choose on your Mac.

Images are often separate files referenced from the document. Keep them with the Markdown when moving a project. A cloud-synced folder is managed by the sync service you choose; Markdown itself does not provide syncing.

Not every renderer looks the same

Headings, paragraphs, emphasis and simple lists are widely supported. Tables, task lists, footnotes, math and diagrams depend on the app displaying the file. Check the destination before relying on those features in a shared document.

Use the syntax reference when you need a pattern, or follow your first document to learn by writing. The CommonMark reference is a useful guide to the core syntax.

Agent-readable/docs/markdown.md
Save .md