Writing

Markdown and formatting

Format as you type with markdown shortcuts, or let the toolbar do it for you.

Every PMKIN document is stored as markdown, the plain-text format developers, AI agents and static site generators all speak. You don't have to know any of it: the editor formats as you go. But if you like typing **bold**, it's all here for you.

Why markdown?#

It goes anywhere. Your website gets clean markdown, or ready-made HTML, from the API. No proprietary blocks to untangle.
Agents read and write it. An AI agent edits the same text you do, and you see exactly what it changed in the document's history.
It stays tidy. No stray fonts, colors or inline styles creeping in from copy and paste.

PMKIN uses GitHub Flavored Markdown (GFM), the variety used on GitHub.

Formatting as you type#

Start a line with one of these and the editor turns it into the real thing:

Type	To get
`##`	Heading 2
`###`	Heading 3
`####`	Heading 4
`-` or `*`	Bulleted list
`1.`	Numbered list
`- [ ]`	To-do list
`>`	Quote
```	Code block
`---`	Horizontal line

And wrap text in these:

Type	To get
`bold`	bold
`italic`	italic
`*both*`	*both*
`~~struck~~`	~~struck~~
`code`	`code`
`[text](https://example.com)`	a link

Tip: Use Heading 2 for your main sections. The title is already the page's top heading, so starting your sections at Heading 2 keeps the outline neat for readers and search engines.

Prefer the mouse? Select text and use the toolbar that appears. The editor covers the toolbar and its keyboard shortcuts.

Lists#

Start a list with -, 1. or - [ ] and keep pressing Enter for the next item. Press Enter twice to end the list.

Check off items in a to-do list by clicking the box.

Links#

Select text and press ⌘K (Ctrl+K), or use the link button in the toolbar. Paste or type the URL and click away to save it.
Type or paste a URL like https://pmkin.io and it becomes a link by itself.
Link to another page on your own site with its path, like /docs/images.

Code blocks#

Type three backticks, or choose Code in the toolbar (⌘⇧E). In a code block, pick the language from Select language to get syntax highlighting.

Tables#

Tables come in when you paste a table from another app, or when an AI agent or the API writes one. In the markdown, a table looks like this:

| Plan | Price |
| --- | --- |
| Free | $0 |

Pasting from other apps#

Paste from Google Docs, Word or a web page and PMKIN keeps what markdown can hold: headings, lists, bold, italic, links and so on. Formatting markdown has no way to store, like underline, colors, highlights and text alignment, is removed as you paste, so what you see is what gets saved.

Images#

Images are markdown too, but you don't need to write it by hand. Drop, paste or upload them; images explains how.