Introduction
Welcome to PeepMD 👋
Thanks for opening PeepMD. This document is itself a demo. Everything you see is plain Markdown, and this file is rendering live right now.
What PeepMD is
PeepMD is built to be your default Markdown viewer: the app a double-clicked .md file opens in, showing the rendered document instead of raw text. You write in whatever editor you like, and PeepMD shows the result. On the Mac it sits beside your editor. Every save appears in the preview within a beat, scroll position intact, and if the change is off screen the preview follows it there. On iPad, iPhone, and Vision Pro it is a reader for the Markdown you keep in Files.
Tip
See the style name at the right of the bar along the bottom? Click or tap it. PeepMD ships with twelve built-in styles. Try Sakura or Tufte on this very document, then come back to GitHub. Your choice sticks.
The basics, all of them
Bold, italic, strikethrough, highlighted, underlined, and inline code. Lists, quotes, links, and footnotes1 work as you'd expect.
Code gets highlighted
struct Greeting {
let text = "Hello from PeepMD"
func deliver() { print(text) }
}
Diagrams draw themselves
graph LR
A[Your editor] -- save --> B[PeepMD re-renders]
B --> C[Preview updates in place]
C -- keep writing --> A
Math, when you need it
Inline math like \(e^{i\pi} + 1 = 0\), or full display equations:
\[\int_{-\infty}^{\infty} e^{-x^2}\,dx = \sqrt{\pi}\]
Front matter becomes properties
A document can open with front matter in YAML or TOML, the metadata block that Obsidian, Jekyll, and Hugo keep at the top of a file. PeepMD shows it in the inspector as properties you can change, add, rename, and reorder. Open the inspector with the button at the end of the toolbar, or with View → Show Inspector on the Mac. On iPhone it is Properties in the export menu. This one has a few to try: text, a date, a list, and a switch. The inspector's Document side counts what is here: words, tasks done, headings, code, and more.
Review with CriticMarkup
Suggestions render inline: this sentence wasis marked up. Looks good, ship it.
Tables and task lists
| Feature | Status |
|---|---|
| Tables | ✓ |
| Task lists | ✓ |
| TextBundle | ✓ |
| Front matter | ✓ |
| PDF and HTML export | ✓ |
- Open PeepMD
- Read the welcome document
- Open one of your own files
Check that last one off when you have. The box writes to the file, the one line and nothing else.
Peek from Finder
On the Mac, select a Markdown file in Finder and press Space: Quick Look shows the page in the style you chose here, diagrams and math included. File icons in Finder and in the Files app on iPad and iPhone show the page itself.
Getting documents in
On the Mac, use File → Open, or drag a file onto the window. To make double-clicking work too, set PeepMD as your default Markdown viewer: right-click any .md file in Finder, choose Get Info, set Open With to PeepMD, then click Change All….
On iPad, iPhone, and Vision Pro, reach for your files under Browse, or send them to PeepMD from wherever they already live. Touch and hold a file in the Files app, or use the share button in almost any app, and choose Open With → PeepMD. Documents opened this way stay where they are.
Either way, PeepMD handles .md, .markdown, .txt, and TextBundle packages.
Where to go next
The full manual covers everything. Finding, exporting, printing, sending email, writing your own styles, and the settings that decide what language PeepMD speaks and whether it reads light or dark. On the Mac it lives in the Help menu. On iPad and iPhone, tap the gear at the left of the floating bar and choose PeepMD Help; on Vision Pro it is the gear in the ornament at the bottom-left of the window.
One last trick: open this file in your own editor, change something, and save. The preview follows along. That's the whole idea.
-
Like this one. ↩