# Inline Todo (行内待办)

**English** | [中文说明见下方](#中文说明)

Checkable inline todos **anywhere in a line** for Obsidian — not just at the start of a list item.

```markdown
Buy groceries[]milk /[]bread /[x]report done/

A todo can also span[]several lines
within the same paragraph,
until the slash/ and normal text continues here.
```

## Features

- **Inline syntax**: `[]text/` = unchecked, `[x]text/` = checked (strikethrough). The todo only covers the text between the markers.
- **Multi-line**: content may span soft line breaks within the same paragraph.
- **Native Markdown inside**: bold, italics, highlights, inline code, links etc. inside the markers are rendered by Obsidian as usual — the plugin only draws the checkbox and the "done" style, and never interferes with inner syntax.
- **Click to toggle** in both Live Preview and Reading mode. State is written back to the file (`[]` ↔ `[x]`).
- **Cursor reveals source**: place the cursor inside a todo in Live Preview and it shows the raw `[]text/` so you can edit it, like native Markdown syntax does.
- **Safe by default**: markers inside inline code / code blocks are ignored. Source mode always shows raw text. An unmatched `[]` or `/` never renders.
- **Escaping**: a literal slash inside the content is written as `\/`.
- **Enter keeps the flow going**: with the cursor at the end of a todo line (`[]text/`), pressing Enter appends a fresh `[]/` right after it and puts the cursor in the middle — write a whole row of todos without stopping. On an empty `[]/` Enter behaves like a normal newline.
- **Blank-line rule when tasks are displayed inline**: a todo row only affects its immediate upper/lower line — a plain-text line joins the row, and a blank line is swallowed (N blank lines render as N−1). This applies in both Live Preview and Reading view.

## Syntax

| Syntax | Meaning |
| --- | --- |
| `[]text/` | unchecked inline todo |
| `[x]text/` | checked inline todo (strikethrough) |
| `\/` inside content | literal `/` |
| (single line break inside) | keeps the todo open (same paragraph only) |
| standard task line ending with `/` (e.g. `- [ ] buy milk/`) | no line break after it — consecutive tasks display in one row |

### Standard tasks, inline display

Keep writing normal Obsidian tasks — they stay 100% visible to Tasks, Dataview and every statistics plugin. Add a trailing `/` to a task line and it joins the next line into a single visual row (the `/` is hidden by this plugin's rendering only):

```markdown
- [ ] buy milk/
- [ ] wash dishes/
- [x] weekly report/
- [ ] backup data
```

`buy milk`, `wash dishes`, `weekly report`, `backup data` and the surrounding plain-text lines all render as **one row**: a run of consecutive non-blank lines is displayed inline as soon as it contains a task line ending with `/`. To split it back into normal lines, insert a blank line. Headings, quotes, code blocks, indented sub-items and other list items also break the run.

## Install

### Community plugins
Search **Inline Todo** in **Settings → Community plugins → Browse**. If it is not listed yet, use one of the options below.

### BRAT (beta)
1. Install [BRAT](https://github.com/TfTHacker/obsidian42-brat) from the community plugins.
2. In BRAT choose **Add Beta plugin** and enter `icecode825/inline-todo`.
3. Enable **Inline Todo** in Settings → Community plugins.

### Manual
Download `main.js`, `manifest.json` and `styles.css` from the [latest release](../../releases/latest) into `<vault>/.obsidian/plugins/inline-todo/`, then enable it in Settings → Community plugins.

## 中文说明

在 Obsidian 里让**一行中的任意位置**都能放可勾选的待办，不再受“待办必须是列表项”的限制。

```markdown
买菜[]牛奶 /[]面包 /[x]周报写完了/

待办也可以[]跨行书写，
只要在同一个段落内，
到斜杠为止/ 后面就恢复普通文字。
```

### 语法

| 写法 | 含义 |
| --- | --- |
| `[]内容/` | 未完成待办 |
| `[x]内容/` | 已完成待办（内容自动划删除线） |
| 内容里的 `\/` | 字面斜杠 `/` |
| 段落内换行 | 待办继续，跨段落不行 |
| 标准任务行尾加 `/`（如 `- [ ] 买菜/`） | 该行不换行，与下一行拼成一行显示 |

### 标准任务横排（推荐，统计全兼容）

照常写 Obsidian 原生任务，源文件 100% 标准，**Tasks、Dataview、一切统计插件完整识别**。给任务行尾加 `/`，连续的任务就在一行内并排显示（`/` 只在本插件渲染时隐藏）：

```markdown
- [ ] 买菜/
- [ ] 洗碗/
- [x] 写周报/
- [ ] 备份数据
```

`买菜`、`洗碗`、`写周报`、`备份数据` 以及夹在中间的文字行全部**横排一行**：连续非空行组成的块中，只要有任务行以 `/` 结尾，整块横排显示。**想断开就插入一个空行**。标题、引用、代码块、缩进子项、其他列表项也会断开横排。

### 行为说明

- **实时预览**与**阅读模式**都渲染，点击复选框直接写回源文件（`[]` ↔ `[x]`）
- **光标进入待办范围**（实时预览）时自动露出原始语法，方便编辑
- **回车连着写**：光标停在 `[]文字/` 行尾按回车，会紧接着生成一个空的 `[]/` 并把光标放在中间，可以一路写下去；空的 `[]/` 上按回车就是普通换行
- **横排时的空行规则**：待办只影响紧邻的上一行/下一行——相邻行是文字就并进同一行，是空行就把这个空行吃掉（N 个空行显示 N-1 个）。实时预览与阅读模式表现一致
- **源码模式**始终显示原始语法
- 行内代码、代码块中的标记**不会误渲染**；没有结束符的 `[]` 也不会
- 待办内部的**加粗、斜体、高亮、链接等一切语法**都按 Obsidian 原生规则渲染，插件只负责待办框和完成样式

### 安装

- **社区插件**：设置 → 第三方插件 → 浏览，搜索 **Inline Todo**（若还未出现在列表里，用下面两种方式）
- **BRAT**：安装 [BRAT](https://github.com/TfTHacker/obsidian42-brat) 后，在 BRAT 里「Add Beta plugin」输入 `icecode825/inline-todo`
- **手动**：从 [最新 Release](../../releases/latest) 下载 `main.js`、`manifest.json`、`styles.css`，放进 `<库文件夹>/.obsidian/plugins/inline-todo/`，再到 设置 → 第三方插件 里启用

## License

[MIT](./LICENSE) © [icecode825](https://github.com/icecode825)