Help & Guides
Syncpen uses Markdown for formatting. Markdown is a simple way to style text using plain characters that are easy to read and write.
Headings
Use # symbols to create headings. More # = smaller heading.
# Heading 1
## Heading 2
### Heading 3Heading 1
Heading 2
Heading 3
Text Formatting
Wrap text with special characters to format it.
**bold text**
*italic text*
~~strikethrough~~
`inline code`bold text
italic text
strikethrough
inline code
Links and Images
Links use [text](url) format. Images add a ! prefix.
[Visit Syncpen](https://syncpen.io)
[Image would appear here]
Table of Contents
Every heading in your document automatically becomes a link target. To build a table of contents, make a list of links that point to your headings using [Title](#anchor).
The anchor is the heading text in lowercase, with spaces turned into hyphens and punctuation removed. For example, ## Project Goals becomes #project-goals.
## Contents
- [Introduction](#introduction)
- [Project Goals](#project-goals)
- [Next Steps](#next-steps)
## Introduction
...
## Project Goals
...
## Next Steps
...Switch to Preview or Split view, then click an entry to jump straight to that section. If two headings share the same text, the second one's anchor gets a number added (#project-goals-1).
Lists
Use - or * for bullet lists, numbers for ordered lists.
- First item
- Second item
- Third item
1. Step one
2. Step two
3. Step three- First item
- Second item
- Third item
- Step one
- Step two
- Step three
Blockquotes
Use > to create a blockquote.
> This is a quote.
> It can span multiple lines.This is a quote. It can span multiple lines.
Code Blocks
Use triple backticks for code blocks. Add a language name for syntax highlighting.
```javascript
function hello() {
console.log("Hello!");
}
```function hello() {
console.log("Hello!");
}Horizontal Rule
Use three dashes to create a divider.
Above the line
---
Below the lineAbove the line
Below the line
Tables
Create tables using pipes and dashes.
| Name | Role |
|-------|--------|
| Alice | Editor |
| Bob | Viewer || Name | Role |
|---|---|
| Alice | Editor |
| Bob | Viewer |
Task Lists
Create checkboxes with - [ ] and - [x].
- [x] Completed task
- [ ] Pending task
- [ ] Another task- Completed task
- Pending task
- Another task
Smart Typography
Syncpen automatically replaces common character sequences with proper typography symbols as you type.
| You type | Becomes | Name |
|---|---|---|
-> | → | Right arrow |
<- | ← | Left arrow |
<-> | ↔ | Bidirectional arrow |
... | … | Ellipsis |
-- | — | Em dash |
(c) | © | Copyright |
(r) | ® | Registered |
(tm) | ™ | Trademark |
Quick Reference
**text** Bold*text* Italic# Heading Heading[text](url) Link[text](#heading) TOC link- item Bullet list1. item Numbered list> text Quote`code` Inline code-> → Arrow-- — Em dash