[PR #1587] [MERGED] Add support for markdown in notes #3833

New Issue

GiteaMirror · 2026-02-28T20:47:28-06:00

GiteaMirror commented

2026-02-28 20:47:28 -06:00

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/1587
Author: @OlegWock
Created: 8/25/2023
Status: ✅ Merged
Merged: 9/4/2023
Merged by: @MatissJanis

Base: master ← Head: master

📝 Commits (8)

e0fe39f Add support for markdown in notes
d38fb41 Add release notes
499e0ef Add parsing and render of directives
4a81424 Fix formatting
b01b5e2 Don't disable eslint
05e32d5 Remove directives plugin
b9446b8 Remove unused deps
0800b44 Resolve merge conflicts

📊 Changes

5 files changed (+1055 additions, -14 deletions)

View changed files

📝 packages/desktop-client/package.json (+3 -0)
📝 packages/desktop-client/src/components/NotesButton.tsx (+77 -11)
➕ packages/desktop-client/src/util/markdown.ts (+38 -0)
➕ upcoming-release-notes/1587.md (+6 -0)
📝 yarn.lock (+931 -3)

📄 Description

As discussed in Discord, this PR adds support for Markdown in notes. This PR introduces a couple of new packages, notably 'react-markdown' to render markdown and 'remark-breaks' and 'remark-gfm' which are plugins for remark (engine used inside react-markdown) to support GitHub flavored markdown (adds a bunch of features and de-facto is standard flavor now) and to support line breaks without need to escape them (not supported in markdown by default). It also has one small plugin sequentialNewlinesPlugin to avoid collapsing multiple line breaks into one.

Looks like this:

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/actualbudget/actual/pull/1587 **Author:** [@OlegWock](https://github.com/OlegWock) **Created:** 8/25/2023 **Status:** ✅ Merged **Merged:** 9/4/2023 **Merged by:** [@MatissJanis](https://github.com/MatissJanis) **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (8) - [`e0fe39f`](https://github.com/actualbudget/actual/commit/e0fe39fc472c9bd1e71cf19e4f535806903f1df9) Add support for markdown in notes - [`d38fb41`](https://github.com/actualbudget/actual/commit/d38fb414aafd64078585e70de5288185ce1cf5e0) Add release notes - [`499e0ef`](https://github.com/actualbudget/actual/commit/499e0efe8aa0ad886324ca78724b4f6a7e46482b) Add parsing and render of directives - [`4a81424`](https://github.com/actualbudget/actual/commit/4a81424e70e7e3ae8b67c99178aa2449fd711a23) Fix formatting - [`b01b5e2`](https://github.com/actualbudget/actual/commit/b01b5e2f71b2e1ded3acc719e5019a2e480372e6) Don't disable eslint - [`05e32d5`](https://github.com/actualbudget/actual/commit/05e32d5750c1de2c5c3dd66abc8825de07a4f3bb) Remove directives plugin - [`b9446b8`](https://github.com/actualbudget/actual/commit/b9446b80a2eef803638b5c4f4fa8cdd31232a402) Remove unused deps - [`0800b44`](https://github.com/actualbudget/actual/commit/0800b44e56c3772d087d05c39cb11ded340dd29c) Resolve merge conflicts ### 📊 Changes **5 files changed** (+1055 additions, -14 deletions) <details> <summary>View changed files</summary> 📝 `packages/desktop-client/package.json` (+3 -0) 📝 `packages/desktop-client/src/components/NotesButton.tsx` (+77 -11) ➕ `packages/desktop-client/src/util/markdown.ts` (+38 -0) ➕ `upcoming-release-notes/1587.md` (+6 -0) 📝 `yarn.lock` (+931 -3) </details> ### 📄 Description As discussed in Discord, this PR adds support for Markdown in notes. This PR introduces a couple of new packages, notably 'react-markdown' to render markdown and 'remark-breaks' and 'remark-gfm' which are plugins for remark (engine used inside react-markdown) to support GitHub flavored markdown (adds a bunch of features and de-facto is standard flavor now) and to support line breaks without need to escape them (not supported in markdown by default). It also has one small plugin `sequentialNewlinesPlugin` to avoid collapsing multiple line breaks into one. Looks like this: ![CleanShot 2023-08-25 at 19 30 46](https://github.com/actualbudget/actual/assets/7430438/137a877a-79ce-4a39-a19c-29820deba199) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2026-02-28 20:47:28 -06:00

GiteaMirror closed this issue