Markdown Editor Guide for Changelogs

Master the ChangeCrab markdown editor to create beautifully formatted changelog entries. Learn formatting, shortcuts, and best practices.

Editor Features

The ChangeCrab editor supports:

• Markdown syntax
• Rich text formatting toolbar
• Live preview
• Code blocks with syntax highlighting
• Image uploads
• Link insertion

Basic Formatting

Headers

# H1 Header
## H2 Header
### H3 Header
#### H4 Header

Text Styles

**bold text**
*italic text*
~~strikethrough~~
`inline code`

Lists

Unordered list:
- Item 1
- Item 2
  - Nested item

Ordered list:
1. First item
2. Second item
3. Third item

Links

[Link text](https://example.com)
[Link with title](https://example.com "Title")

Code Blocks

```javascript
function example() {
    return "Hello";
}
```

Advanced Features

Images

Upload images directly or use image URLs:

![Alt text](image-url.jpg)
![Alt text](image-url.jpg "Image title")

Blockquotes

> This is a blockquote
> It can span multiple lines

Tables

| Column 1 | Column 2 |
|----------|----------|
| Data 1   | Data 2   |

Keyboard Shortcuts

• Ctrl/Cmd + B - Bold
• Ctrl/Cmd + I - Italic
• Ctrl/Cmd + K - Insert link
• Ctrl/Cmd + S - Save

Best Practices

• Use headers to structure content
• Keep paragraphs short and readable
• Use lists for multiple items
• Add code examples when relevant
• Include images to illustrate changes

Next Steps

• Create your first entry
• Use AI assistant to help with formatting