Markdown Support in Event Descriptions
WhenToMeet supports Markdown formatting in event descriptions, allowing you to create rich, formatted text that enhances the presentation of your events.
What is Markdown?
Markdown is a lightweight markup language that allows you to format text using simple syntax. It's widely used across the web and is easy to learn and use.
Supported Markdown Features
WhenToMeet supports GitHub Flavored Markdown (GFM), which includes:
Basic Formatting
- Bold text:
**bold**or__bold__→ bold - Italic text:
*italic*or_italic_→ italic Inline code:`code`→codeStrikethrough:~~strikethrough~~→strikethrough
Headers
# Header 1
## Header 2
### Header 3
Lists
Unordered lists:
- Item 1
- Item 2
- Nested item
- Another nested item
Ordered lists:
1. First item
2. Second item
3. Third item
Links
- Links:
[Link text](https://example.com)→ Link text
Tables
| Column 1 | Column 2 | Column 3 |
| -------- | -------- | --------- |
| Row 1 | Data | More data |
| Row 2 | Data | More data |
Blockquotes
> This is a blockquote
> It can span multiple lines
Where Markdown is Supported
Markdown formatting is supported in:
- Event descriptions when creating new events
- Bookable event descriptions in your booking page setup
Tips for Using Markdown
- Keep it simple: While many features are supported, remember that event descriptions should be clear and concise
- Preview your content: The markdown will be rendered automatically when viewing your event
- Use headers sparingly: In event descriptions, headers can help organize longer content
- Links open in new tabs: All links in markdown content automatically open in new browser tabs for better user experience
Examples
Simple Event Description
Join us for our **weekly team standup**!
We'll cover:
- Project updates
- Blockers and challenges
- Next week's priorities
_Please bring your coffee and good vibes!_ ☕
Detailed Event with Structure
# Product Launch Meeting
## Agenda
1. **Market Research Results** - Sarah (15 min)
2. **Technical Implementation** - Dev Team (20 min)
3. **Marketing Strategy** - Marketing Team (15 min)
4. **Q&A Session** - Everyone (10 min)
## Preparation
Please review the [documentation](/docs) before the meeting.
> **Note**: This meeting will be recorded for team members who cannot attend.
## Contact
Questions? Reach out to [project-lead@company.com](mailto:project-lead@company.com)
Accessibility
The markdown renderer in WhenToMeet is designed with accessibility in mind:
- Proper heading hierarchy for screen readers
- High contrast colors for better readability
- Keyboard navigation support
- Alt text support for images
Need Help?
If you're new to Markdown, here are some helpful resources:
- Markdown Guide - Comprehensive markdown tutorial
- GitHub Flavored Markdown Spec - Technical specification
- Markdown Cheat Sheet - Quick reference
Remember: Markdown is optional! You can still use plain text in your event descriptions if you prefer.