Everything you need to know about BunnyEdit and markdown editing
BunnyEdit is a professional-grade markdown editor designed exclusively for macOS. It provides a beautiful, distraction-free writing environment with live preview, advanced formatting tools, and seamless document organization.
Built with native macOS technologies, BunnyEdit offers Apple-level quality with features like real-time syntax highlighting, document outline navigation, smart auto-completion, and comprehensive export options.
Markdown is a lightweight markup language that uses plain text formatting syntax. It was created by John Gruber in 2004 to make writing for the web easier and more readable.
Markdown files are just plain text files (usually with .md extension) that can be opened and edited anywhere. They use simple symbols like **bold**, *italic*, and # headings to format text.
Why use Markdown?
Minimum Requirements:
Recommended:
Currently, BunnyEdit is available only for macOS. However, iOS and iPadOS versions are planned for future releases!
When the mobile versions are released, they will include:
Want to be notified when mobile versions are available? Contact us to join the early access list.
BunnyEdit offers flexible pricing options:
All plans include:
The free trial gives you 7 days of full, unrestricted access to all of BunnyEdit's features:
No credit card required. Just download, install, and start writing!
Each BunnyEdit license allows activation on up to 3 devices.
Managing Devices:
Need to use BunnyEdit on more than 3 devices? Contact us for team licensing options.
We offer a 7-day free trial so you can try BunnyEdit risk-free before purchasing.
Subscription Refunds:
To request a refund, contact our support team with your license key.
Yes! We offer special pricing for:
Contact us with proof of eligibility to receive your discount code.
Syntax highlighting colors your markdown text in real-time as you type, making it easier to see the structure of your document.
What gets highlighted:
You can enable/disable syntax highlighting in Settings → Editor.
The document outline (also called table of contents) automatically extracts all headings from your markdown document and displays them in a hierarchical, clickable list.
Features:
Perfect for navigating long documents like technical documentation, research papers, or books!
Auto-completion helps you write markdown faster by automatically completing syntax patterns.
Examples:
[ → automatically adds ]() for links``` → creates a code block with closing ```* at line start → continues bullet list1. at line start → continues numbered list**, __, ``, (), []Enable/disable in Settings → Editor → Auto-completion.
BunnyEdit supports multiple export formats:
Export Options:
Yes! BunnyEdit includes intelligent auto-save to protect your work.
Auto-save features:
Configure auto-save in Settings → General → Auto-save interval.
BunnyEdit offers powerful search capabilities:
Global Search (All Documents):
Find & Replace (Current Document):
Open find & replace with ⌘F.
Yes! BunnyEdit fully supports macOS appearance modes.
Appearance options:
All UI elements, syntax highlighting, and preview adapt seamlessly to your chosen theme.
Change appearance in Settings → Appearance → Theme.
Your documents are 100% private and stored locally on your Mac.
Privacy Features:
~/Documents/BunnyEdit (customizable)Here are the most common markdown formatting options:
| Format | Syntax | Example |
|---|---|---|
| Bold | **text** or __text__ |
bold text |
| Italic | *text* or _text_ |
italic text |
| Strikethrough | ~~text~~ |
|
| Inline Code | `code` |
code |
| Link | [text](url) |
link text |
| Image |  |
(image) |
Headings are created with # symbols. The number of symbols determines the heading level:
| Syntax | Output |
|---|---|
# Heading 1 |
Heading 1 |
## Heading 2 |
Heading 2 |
### Heading 3 |
Heading 3 |
#### Heading 4 |
Heading 4 |
##### Heading 5 |
Heading 5 |
###### Heading 6 |
Heading 6 |
Tip: Headings appear in the document outline for easy navigation!
Unordered Lists (Bullets):
- Item 1
- Item 2
- Nested item
- Another nested item
- Item 3You can also use * or + instead of -.
Ordered Lists (Numbers):
1. First item
2. Second item
3. Third item
1. Nested numbered item
2. Another nested itemTask Lists (Checkboxes):
- [ ] Unchecked task
- [x] Completed task
- [ ] Another taskTip: Press Tab to indent and create nested lists.
Inline Code:
Use single backticks: `code here`
Code Blocks (Fenced):
Use triple backticks with optional language identifier:
```javascript
function hello() {
console.log("Hello, World!");
}
```Supported Languages:
```javascript```python```swift```html```css```json```bashIndented Code Blocks:
Indent lines with 4 spaces or 1 tab:
This is a code block
Another line of codeTables use pipes | and hyphens -:
| Header 1 | Header 2 | Header 3 |
|----------|----------|----------|
| Row 1 | Data | Data |
| Row 2 | Data | Data |Column Alignment:
| Left | Center | Right |
|:---------|:--------:|---------:|
| Left | Center | Right |
| Aligned | Aligned | Aligned |:--- = Left aligned:---: = Center aligned---: = Right alignedTip: Use BunnyEdit's table insertion button (toolbar) for easy table creation!
Inline Links:
[Link text](https://example.com)Links with Titles (hover text):
[Link text](https://example.com "Hover title")Reference Links:
[Link text][reference]
[reference]: https://example.comAutomatic Links:
https://example.com
<https://example.com>
<email@example.com>Anchor Links (same document):
[Jump to section](#section-name)Use > at the beginning of lines:
> This is a blockquote.
> It can span multiple lines.Nested Blockquotes:
> First level
> > Second level
> > > Third levelBlockquotes with Formatting:
> **Bold text** in a quote
>
> - List item in quote
> - Another itemUse three or more hyphens, asterisks, or underscores:
---
***
___All three create the same horizontal line.
Basic Image Syntax:
Image with Title:
Reference-style Images:
![Alt text][image-ref]
[image-ref]: image-url.jpgLinked Images:
[](https://link-url.com)Note: Image insertion and preview coming in BunnyEdit v1.2!
BunnyEdit supports GitHub Flavored Markdown (GFM) with extended syntax:
Strikethrough:
~~strikethrough text~~Task Lists:
- [x] Completed task
- [ ] Incomplete taskAutomatic URL Linking:
https://example.com (becomes clickable)Footnotes:
Here's a sentence with a footnote.[^1]
[^1]: This is the footnote text.Definition Lists:
Term
: DefinitionHighlight (extended):
==highlighted text==Subscript/Superscript (extended):
H~2~O (subscript)
X^2^ (superscript)Use a backslash \ before the character to display it literally:
| Character | Escaped Syntax | Purpose |
|---|---|---|
\ |
\\ |
Backslash |
` |
\` |
Backtick |
* |
\* |
Asterisk |
_ |
\_ |
Underscore |
# |
\# |
Hash/Pound |
- |
\- |
Hyphen/Dash |
[ ] |
\[ \] |
Brackets |
Example:
This is \*not\* italic
This is \_not\_ italic
\# This is not a headingHere are the best resources for learning and mastering markdown:
Official Documentation:
Learning Guides:
Cheat Sheets:
Tools & Utilities:
GitHub Flavored Markdown (GFM) is an extension of standard markdown with additional features used on GitHub.
Additional Features in GFM:
- [ ] and - [x]~~text~~ creates crossed-out text:smile:BunnyEdit fully supports GitHub Flavored Markdown!
Try these troubleshooting steps:
1. Check System Requirements:
2. Restart BunnyEdit:
3. Reset Preferences:
~/Library/Preferences/com.robertgrow.BunnyEdit.plist4. Reinstall:
Still having issues? Contact Support with details about the crash.
Common License Issues:
1. Check Internet Connection:
2. Verify License Key:
3. Check Device Limit:
4. License Expired or Revoked:
Contact Support if you continue having issues.
Troubleshooting Export Issues:
1. Check Document Content:
2. Check File Permissions:
3. PDF Export Issues:
4. Reset Export Settings:
If exports continue to fail, contact support with your document and export settings.