From 4e23e6724493a8d112c6ff22e14cf4aabd5e9af1 Mon Sep 17 00:00:00 2001
From: Oskar Manhart <52569953+oskardotglobal@users.noreply.github.com>
Date: Mon, 11 Sep 2023 08:11:42 +0200
Subject: [PATCH] feat: plugin for remark-breaks (#467)
* feat: plugin for remark-breaks
* fix: update package-lock.json
* fix: styling
Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
* Update linebreaks.ts
* Update index.ts
---------
Co-authored-by: Jacky Zhao <j.zhao2k19@gmail.com>
---
package-lock.json | 28 +++++++++++++++++++++++
package.json | 1 +
quartz/plugins/transformers/index.ts | 1 +
quartz/plugins/transformers/linebreaks.ts | 11 +++++++++
4 files changed, 41 insertions(+)
create mode 100644 quartz/plugins/transformers/linebreaks.ts
diff --git a/package-lock.json b/package-lock.json
index 9246cc9..a19d81c 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -45,6 +45,7 @@
"rehype-raw": "^6.1.1",
"rehype-slug": "^5.1.0",
"remark": "^14.0.2",
+ "remark-breaks": "^3.0.3",
"remark-frontmatter": "^4.0.1",
"remark-gfm": "^3.0.1",
"remark-math": "^5.1.1",
@@ -3810,6 +3811,19 @@
"url": "https://opencollective.com/unified"
}
},
+ "node_modules/mdast-util-newline-to-break": {
+ "version": "1.0.0",
+ "resolved": "https://registry.npmjs.org/mdast-util-newline-to-break/-/mdast-util-newline-to-break-1.0.0.tgz",
+ "integrity": "sha512-491LcYv3gbGhhCrLoeALncQmega2xPh+m3gbsIhVsOX4sw85+ShLFPvPyibxc1Swx/6GtzxgVodq+cGa/47ULg==",
+ "dependencies": {
+ "@types/mdast": "^3.0.0",
+ "mdast-util-find-and-replace": "^2.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/unified"
+ }
+ },
"node_modules/mdast-util-phrasing": {
"version": "3.0.1",
"resolved": "https://registry.npmjs.org/mdast-util-phrasing/-/mdast-util-phrasing-3.0.1.tgz",
@@ -4903,6 +4917,20 @@
"url": "https://opencollective.com/unified"
}
},
+ "node_modules/remark-breaks": {
+ "version": "3.0.3",
+ "resolved": "https://registry.npmjs.org/remark-breaks/-/remark-breaks-3.0.3.tgz",
+ "integrity": "sha512-C7VkvcUp1TPUc2eAYzsPdaUh8Xj4FSbQnYA5A9f80diApLZscTDeG7efiWP65W8hV2sEy3JuGVU0i6qr5D8Hug==",
+ "dependencies": {
+ "@types/mdast": "^3.0.0",
+ "mdast-util-newline-to-break": "^1.0.0",
+ "unified": "^10.0.0"
+ },
+ "funding": {
+ "type": "opencollective",
+ "url": "https://opencollective.com/unified"
+ }
+ },
"node_modules/remark-frontmatter": {
"version": "4.0.1",
"resolved": "https://registry.npmjs.org/remark-frontmatter/-/remark-frontmatter-4.0.1.tgz",
diff --git a/package.json b/package.json
index 6ed52d6..95c57cd 100644
--- a/package.json
+++ b/package.json
@@ -69,6 +69,7 @@
"rehype-raw": "^6.1.1",
"rehype-slug": "^5.1.0",
"remark": "^14.0.2",
+ "remark-breaks": "^3.0.3",
"remark-frontmatter": "^4.0.1",
"remark-gfm": "^3.0.1",
"remark-math": "^5.1.1",
diff --git a/quartz/plugins/transformers/index.ts b/quartz/plugins/transformers/index.ts
index d9f2854..e340f10 100644
--- a/quartz/plugins/transformers/index.ts
+++ b/quartz/plugins/transformers/index.ts
@@ -8,3 +8,4 @@ export { ObsidianFlavoredMarkdown } from "./ofm"
export { OxHugoFlavouredMarkdown } from "./oxhugofm"
export { SyntaxHighlighting } from "./syntax"
export { TableOfContents } from "./toc"
+export { HardLineBreaks } from "./linebreaks"
diff --git a/quartz/plugins/transformers/linebreaks.ts b/quartz/plugins/transformers/linebreaks.ts
new file mode 100644
index 0000000..a8a066f
--- /dev/null
+++ b/quartz/plugins/transformers/linebreaks.ts
@@ -0,0 +1,11 @@
+import { QuartzTransformerPlugin } from "../types"
+import remarkBreaks from "remark-breaks"
+
+export const HardLineBreaks: QuartzTransformerPlugin = () => {
+ return {
+ name: "HardLineBreaks",
+ markdownPlugins() {
+ return [remarkBreaks]
+ },
+ }
+}