diff options
| author | Christopher Warner <cwarner@kernelcode.com> | 2026-10-10 18:58:00 -0400 |
|---|---|---|
| committer | Christopher Warner <cwarner@kernelcode.com> | 2026-10-10 18:58:00 -0400 |
| commit | 41d0d57b0897bf1d8fd4db7f16f5ce454c3b74b9 (patch) | |
| tree | f7670272f347e5911bfe15f13d72a88b9ed4cfa3 /README.md | |
| parent | ce524225a4c74aed82813b9bc067fd54c8160516 (diff) | |
| download | iphone-notes-41d0d57b0897bf1d8fd4db7f16f5ce454c3b74b9.tar.gz iphone-notes-41d0d57b0897bf1d8fd4db7f16f5ce454c3b74b9.tar.bz2 iphone-notes-41d0d57b0897bf1d8fd4db7f16f5ce454c3b74b9.tar.xz iphone-notes-41d0d57b0897bf1d8fd4db7f16f5ce454c3b74b9.zip | |
feat(format): align note markup with Apple Notes Support guides
Map * / - to bulleted vs dashed lists, add divider and block-quote
stand-ins, and render simple tables per Apple's Notes formatting docs.
Co-authored-by: Cursor <cursoragent@cursor.com>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 11 insertions, 8 deletions
@@ -27,14 +27,17 @@ icloud-note update --title "Hello" --body "Revised from Linux" ## Formatting -Bodies may be plain text or light Markdown. The CLI rewrites them to **Apple Notes -style** before writing: - -- First line = Title; blank line before the rest -- `##` / `###` → Heading / Subheading (no `#` markers) -- `-` / `*` bullets → `•`; `1.` lists kept; `- [ ]` / `- [x]` → ☐ / ☑ -- Inline `**bold**`, links, and outer code fences cleaned up -- Short paragraphs and list blocks spaced like Notes (not a Markdown dump) +Bodies may be plain text or light Markdown. The CLI rewrites them to match +[Apple Notes formatting](https://support.apple.com/guide/iphone/create-and-format-notes-iph1ac0b3a2/ios) +([Mac guide](https://support.apple.com/guide/notes/format-notes-apd1955d3b21/mac), +[lists](https://support.apple.com/guide/notes/add-lists-apd93c815aa0/mac)): + +- First line = **Title**; blank line before the rest +- `##` / `###` → **Heading** / **Subheading** (collapsible sections on device) +- List shortcuts: `*` → bulleted (`•`), `-` → dashed (`–`), `1.` → numbered +- `- [ ]` / `- [x]` → checklist (☐ / ☑) +- `---` → divider line; `> …` → block quote; pipe tables → aligned monospaced grid +- Inline `**bold**` / links / fences cleaned (rich bold/highlight needs the iOS UI) `ICLOUD_NOTES_DRY_RUN=1` prints a formatted preview without touching iCloud. |
