事件描述中的 Markdown 支持

WhenToMeet 支持在事件描述中使用 Markdown 格式,帮助你创建更丰富、结构更清晰的内容。

什么是 Markdown?

Markdown 是一种轻量级标记语言,使用简单的语法即可为文本添加格式,广泛用于网络内容中。

支持的 Markdown 功能

WhenToMeet 支持 GitHub Flavored Markdown(GFM),包括:

基本格式

  • 加粗文本**bold**__bold__bold
  • 斜体文本*italic*_italic_italic
  • 行内代码`code`code
  • 删除线~~strikethrough~~strikethrough

标题

# 一级标题

## 二级标题

### 三级标题

列表

无序列表:

- 项目 1
- 项目 2
  - 子项目
  - 另一个子项目

有序列表:

1. 第一项
2. 第二项
3. 第三项

链接

  • 链接:[链接文本](https://example.com)链接文本

表格

| 列 1 | 列 2 | 列 3     |
| ---- | ---- | -------- |
| 行 1 | 数据 | 更多数据 |
| 行 2 | 数据 | 更多数据 |

引用块

> 这是一个引用块
> 可以跨多行

支持 Markdown 的位置

Markdown 格式支持以下位置:

  • 创建新事件时的事件描述
  • 预约页面设置中的可预约事件描述

使用技巧

  1. 保持简洁:尽管支持多种格式,但事件描述应清晰简洁
  2. 预览内容:查看事件时会自动渲染 Markdown
  3. 适度使用标题:较长内容可用标题组织结构
  4. 链接在新标签中打开:Markdown 内容里的所有链接都会在新标签中打开,提升用户体验

示例

简单的事件描述

欢迎参加我们的**每周例会**

我们将讨论:

- 项目进展
- 阻碍与挑战
- 下周重点

_请带上咖啡与好心情!_

结构化的详细事件

# 产品发布会议

## 议程

1. **市场调研结果** - Sarah(15 分钟)
2. **技术实现** - 开发团队(20 分钟)
3. **营销策略** - 市场团队(15 分钟)
4. **问答** - 全员(10 分钟)

## 准备

请在会前查看[文档](/docs)

> **注意**:会议将会录制,供未能参加的同事观看。

## 联系方式

有问题?请联系 [project-lead@company.com](mailto:project-lead@company.com)

无障碍性

WhenToMeet 的 Markdown 渲染器在设计上考虑了无障碍:

  • 合理的标题层级以便屏幕阅读器识别
  • 高对比度配色以提高可读性
  • 键盘可访问性
  • 图片的替代文本支持

需要帮助?

如果你刚接触 Markdown,可参考:

提示:Markdown 并非必需!如果你愿意,也可以直接使用纯文本。

Was this page helpful?