Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
fix(markdown): round-trip multicolumn layouts through export and import
Elian Doran1f3ea607dddc
diff --git a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Multicolumn layout.html b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Multicolumn layout.htmlindex 5828dff8d2..ace3100656 100644--- a/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Multicolumn layout.html+++ b/apps/server/src/assets/doc_notes/en/User Guide/User Guide/Note Types/Text/Multicolumn layout.html@@ -62,6 +62,9 @@<ul><li>When printing or <a href="#root/_help_NRnIZmSMc5sj">exporting to PDF</a>,the columns are printed side by side.</li>- <li>Markdown has no columns, so Markdown export writes the content of the+ <li>Markdown has no columns, so Markdown export keeps the layout and each+ column as HTML <code><div></code> tags, with the content of each column+ written as Markdown between them. Importing the file back restores the+ layout. Markdown viewers that don't support HTML show the content of thecolumns one after another.</li></ul>\ No newline at end of filediff --git a/docs/User Guide/User Guide/Note Types/Text/Multicolumn layout.md b/docs/User Guide/User Guide/Note Types/Text/Multicolumn layout.mdindex 8782a97aa8..afa0ded10c 100644--- a/docs/User Guide/User Guide/Note Types/Text/Multicolumn layout.md+++ b/docs/User Guide/User Guide/Note Types/Text/Multicolumn layout.md@@ -33,4 +33,4 @@ When a layout has too little room for its columns (narrower than about 500 pixel## Printing and exporting* When printing or [exporting to PDF](../../Basic%20Concepts%20and%20Features/Notes/Printing%20%26%20Exporting%20as%20PDF.md), the columns are printed side by side.-* Markdown has no columns, so Markdown export writes the content of the columns one after another.\ No newline at end of file+* Markdown has no columns, so Markdown export keeps the layout and each column as HTML `<div>` tags, with the content of each column written as Markdown between them. Importing the file back restores the layout. Markdown viewers that don't support HTML show the content of the columns one after another.\ No newline at end of filediff --git a/packages/ckeditor5/src/plugins/multicolumn/constants.ts b/packages/ckeditor5/src/plugins/multicolumn/constants.tsindex a5ee942e36..a53577c24c 100644--- a/packages/ckeditor5/src/plugins/multicolumn/constants.ts+++ b/packages/ckeditor5/src/plugins/multicolumn/constants.ts@@ -1,4 +1,4 @@-import { MULTICOLUMN_LAYOUT_CLASS } from "@triliumnext/commons";+import { MULTICOLUMN_COLUMN_CLASS, MULTICOLUMN_LAYOUT_CLASS } from "@triliumnext/commons";/** Model element names of the multicolumn layout. */export const ELEMENTS = {@@ -10,6 +10,7 @@ export const ELEMENTS = {export const RATIOS_ATTRIBUTE = "columnRatios";export const LAYOUT_CLASS = MULTICOLUMN_LAYOUT_CLASS;+export const COLUMN_CLASS = MULTICOLUMN_COLUMN_CLASS;export const RATIOS_DATA_ATTRIBUTE = "data-trilium-column-ratios";/** Custom property that marks the editing-view widget element of a layout. */diff --git a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_editing.spec.ts b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_editing.spec.tsindex e58c13764f..78da8f3f2b 100644--- a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_editing.spec.ts+++ b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_editing.spec.ts@@ -15,11 +15,13 @@ import Tabs from "../tabs/tabs.js";import { getDefaultRatios } from "./constants.js";import Multicolumn from "./multicolumn.js";+const column = (content: string) => `<div class="trilium-multicolumn-column">${content}</div>`;+const TWO_COLUMNS =- "<section class=\"trilium-multicolumn-layout\" data-trilium-column-ratios=\"1-3\">" +- "<section><p>First column</p></section>" +- "<section><p>Second column</p></section>" +- "</section>";+ "<div class=\"trilium-multicolumn-layout\" data-trilium-column-ratios=\"1-3\">" ++ column("<p>First column</p>") ++ column("<p>Second column</p>") ++ "</div>";describe("MulticolumnEditing", () => {let editor: ClassicEditor;@@ -60,7 +62,7 @@ describe("MulticolumnEditing", () => {const widget = root?.querySelector(".trilium-multicolumn-layout");expect(widget?.classList.contains("ck-widget")).toBe(true);expect(widget?.getAttribute("data-trilium-column-ratios")).toBe("1-3");- const columns = widget?.querySelectorAll(":scope > section") ?? [];+ const columns = widget?.querySelectorAll(":scope > .trilium-multicolumn-column") ?? [];expect([...columns].map(column => column.getAttribute("contenteditable"))).toEqual(["true", "true"]);expect(columns[0]?.getAttribute("aria-label")).toContain("Column");@@ -77,8 +79,8 @@ describe("MulticolumnEditing", () => {expect(widget?.getAttribute("data-trilium-column-ratios")).toBe("3-1");});- it("reads a plain section outside a layout as something else", () => {- editor.setData("<section><p>Text</p></section>");+ it("reads a column outside a layout as its content", () => {+ editor.setData(column("<p>Text</p>"));expect(model()).toBe("<paragraph>Text</paragraph>");});@@ -88,7 +90,7 @@ describe("MulticolumnEditing", () => {/** Whether the first block of each column shows the placeholder. */function placeholders() {const root = editor.editing.view.getDomRoot();- const columns = root?.querySelectorAll(".trilium-multicolumn-layout > section") ?? [];+ const columns = root?.querySelectorAll(".trilium-multicolumn-column") ?? [];return [...columns].map(column =>column.firstElementChild?.classList.contains("ck-placeholder") ?? false);}@@ -148,16 +150,16 @@ describe("MulticolumnEditing", () => {describe("post-fixer", () => {it("removes a layout without columns", () => {- editor.setData("<p>Before</p><section class=\"trilium-multicolumn-layout\"></section>");+ editor.setData("<p>Before</p><div class=\"trilium-multicolumn-layout\"></div>");expect(model()).toBe("<paragraph>Before</paragraph>");});it("adds an empty column to a layout with one column", () => {editor.setData(- "<section class=\"trilium-multicolumn-layout\">" +- "<section><p>Only</p></section>" +- "</section>"+ "<div class=\"trilium-multicolumn-layout\">" ++ "<div class=\"trilium-multicolumn-column\"><p>Only</p></div>" ++ "</div>");expect(model()).toBe(@@ -170,9 +172,9 @@ describe("MulticolumnEditing", () => {it("merges the columns past the fourth into the fourth, in order", () => {const columns = ["A", "B", "C", "D", "E", "F"]- .map(text => `<section><p>${text}</p></section>`)+ .map(text => column(`<p>${text}</p>`)).join("");- editor.setData(`<section class="trilium-multicolumn-layout">${columns}</section>`);+ editor.setData(`<div class="trilium-multicolumn-layout">${columns}</div>`);expect(model()).toBe("<multicolumnLayout columnRatios=\"1-1-1-1\">" +@@ -189,20 +191,20 @@ describe("MulticolumnEditing", () => {it("merges columns past the fourth without adding blank lines for empty ones", () => {const columns = ["<p>A</p>", "<p>B</p>", "<p>C</p>", "", "<p>E</p>", ""];editor.setData(- "<section class=\"trilium-multicolumn-layout\">" +- columns.map(column => `<section>${column}</section>`).join("") +- "</section>"+ "<div class=\"trilium-multicolumn-layout\">" ++ columns.map(column).join("") ++ "</div>");expect((layoutAt(0).getChild(3) as ModelElement).childCount).toBe(1);- expect(editor.getData()).toContain("<section><p>E</p></section></section>");+ expect(editor.getData()).toContain(`${column("<p>E</p>")}</div>`);});it("gives an empty column a paragraph", () => {editor.setData(- "<section class=\"trilium-multicolumn-layout\">" +- "<section></section><section><p>B</p></section>" +- "</section>"+ "<div class=\"trilium-multicolumn-layout\">" ++ column("") + column("<p>B</p>") ++ "</div>");expect(model()).toBe(@@ -215,11 +217,11 @@ describe("MulticolumnEditing", () => {it("resets weights that are missing, unknown or meant for another column count", () => {const layout = (ratios: string) =>- `<section class="trilium-multicolumn-layout"${ratios}>` +- "<section><p>A</p></section>" +- "<section><p>B</p></section>" +- "<section><p>C</p></section>" +- "</section>";+ `<div class="trilium-multicolumn-layout"${ratios}>` ++ "<div class=\"trilium-multicolumn-column\"><p>A</p></div>" ++ "<div class=\"trilium-multicolumn-column\"><p>B</p></div>" ++ "<div class=\"trilium-multicolumn-column\"><p>C</p></div>" ++ "</div>";editor.setData(layout("") +layout(" data-trilium-column-ratios=\"2-5-1\"") +@@ -240,14 +242,14 @@ describe("MulticolumnEditing", () => {it("fixes a layout nested in a column", () => {editor.setData(- "<section class=\"trilium-multicolumn-layout\">" +- "<section>" +- "<section class=\"trilium-multicolumn-layout\">" +- "<section><p>Inner</p></section>" +- "</section>" +- "</section>" +- "<section><p>Outer</p></section>" +- "</section>"+ "<div class=\"trilium-multicolumn-layout\">" ++ "<div class=\"trilium-multicolumn-column\">" ++ "<div class=\"trilium-multicolumn-layout\">" ++ "<div class=\"trilium-multicolumn-column\"><p>Inner</p></div>" ++ "</div>" ++ "</div>" ++ "<div class=\"trilium-multicolumn-column\"><p>Outer</p></div>" ++ "</div>");expect(model()).toBe(diff --git a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_editing.ts b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_editing.tsindex cde86188f4..6e4060439b 100644--- a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_editing.ts+++ b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_editing.ts@@ -9,14 +9,13 @@ import {toWidget,toWidgetEditable,type ViewEditableElement,- type ViewElement,Widget} from "ckeditor5";import NestedLimitSelection from "../nested_limit_selection.js";import {- COLUMN_RATIOS, ELEMENTS, getColumnCount, getDefaultRatios, LAYOUT_CLASS, LAYOUT_WIDGET_PROPERTY,- MAX_COLUMNS, MIN_COLUMNS, RATIOS_ATTRIBUTE, RATIOS_DATA_ATTRIBUTE+ COLUMN_CLASS, COLUMN_RATIOS, ELEMENTS, getColumnCount, getDefaultRatios, LAYOUT_CLASS,+ LAYOUT_WIDGET_PROPERTY, MAX_COLUMNS, MIN_COLUMNS, RATIOS_ATTRIBUTE, RATIOS_DATA_ATTRIBUTE} from "./constants.js";import {ColumnLayoutCommand, InsertMulticolumnLayoutCommand, RemoveMulticolumnLayoutCommand,@@ -66,14 +65,14 @@ export default class MulticolumnEditing extends Plugin {const conversion = editor.conversion;const t = editor.t;- // High priority runs the upcasts before General HTML Support, which also matches sections.+ // High priority runs the upcasts before General HTML Support, which also matches `<div>`s.conversion.for("upcast").elementToElement({- view: { name: "section", classes: LAYOUT_CLASS },+ view: { name: "div", classes: LAYOUT_CLASS },model: ELEMENTS.layout,converterPriority: "high"});conversion.for("upcast").elementToElement({- view: matchColumn,+ view: { name: "div", classes: COLUMN_CLASS },model: ELEMENTS.column,converterPriority: "high"});@@ -85,19 +84,20 @@ export default class MulticolumnEditing extends Plugin {conversion.for("dataDowncast").elementToElement({model: ELEMENTS.layout,view: (_model, { writer }) =>- writer.createContainerElement("section", { class: LAYOUT_CLASS })+ writer.createContainerElement("div", { class: LAYOUT_CLASS })});conversion.for("dataDowncast").elementToElement({model: ELEMENTS.column,- view: (_model, { writer }) => writer.createContainerElement("section")+ view: (_model, { writer }) =>+ writer.createContainerElement("div", { class: COLUMN_CLASS })});conversion.for("editingDowncast").elementToElement({model: ELEMENTS.layout,view: (_model, { writer }) => {- const section = writer.createContainerElement("section", { class: LAYOUT_CLASS });- writer.setCustomProperty(LAYOUT_WIDGET_PROPERTY, true, section);- return toWidget(section, writer, {+ const layout = writer.createContainerElement("div", { class: LAYOUT_CLASS });+ writer.setCustomProperty(LAYOUT_WIDGET_PROPERTY, true, layout);+ return toWidget(layout, writer, {label: t("Multicolumn layout"),hasSelectionHandle: true});@@ -106,16 +106,16 @@ export default class MulticolumnEditing extends Plugin {conversion.for("editingDowncast").elementToElement({model: ELEMENTS.column,view: (_model, { writer }) => {- const section: ViewEditableElement & PlaceholderableViewElement =- writer.createEditableElement("section");- section.placeholder = t("Type content here…");+ const column: ViewEditableElement & PlaceholderableViewElement =+ writer.createEditableElement("div", { class: COLUMN_CLASS });+ column.placeholder = t("Type content here…");enableViewPlaceholder({view: editor.editing.view,- element: section,+ element: column,isDirectHost: false,keepOnFocus: true});- return toWidgetEditable(section, writer, { label: t("Column") });+ return toWidgetEditable(column, writer, { label: t("Column") });}});}@@ -152,15 +152,6 @@ export default class MulticolumnEditing extends Plugin {}}-/** Matches a `<section>` directly inside a layout. Columns have no class of their own. */-function matchColumn(element: ViewElement) {- const parent = element.parent;- if (element.name === "section" && parent?.is("element") && parent.hasClass(LAYOUT_CLASS)) {- return { name: true };- }- return null;-}-function collectLayoutsAround(position: ModelPosition, layouts: Set<ModelElement>) {for (const ancestor of position.getAncestors()) {if (ancestor.is("element", ELEMENTS.layout)) {diff --git a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_layout.spec.ts b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_layout.spec.tsindex da19f6fe11..7030587868 100644--- a/packages/ckeditor5/src/plugins/multicolumn/multicolumn_layout.spec.ts+++ b/packages/ckeditor5/src/plugins/multicolumn/multicolumn_layout.spec.ts@@ -14,9 +14,11 @@ function savedGapOf(layout: Element) {}function layoutHtml(ratios: string, columns: string[]) {- const content = columns.map(column => `<section>${column}</section>`).join("");- return `<section class="trilium-multicolumn-layout" data-trilium-column-ratios="${ratios}">` +- `${content}</section>`;+ const content = columns+ .map(column => `<div class="trilium-multicolumn-column">${column}</div>`)+ .join("");+ return `<div class="trilium-multicolumn-layout" data-trilium-column-ratios="${ratios}">` ++ `${content}</div>`;}/** Renders saved HTML the way the read-only view and shared pages do. */@@ -31,7 +33,9 @@ function renderContent(html: string, width: number) {}function columnsOf(layout: Element | null | undefined) {- return [...layout?.querySelectorAll<HTMLElement>(":scope > section") ?? []];+ return [+ ...layout?.querySelectorAll<HTMLElement>(":scope > .trilium-multicolumn-column") ?? []+ ];}/** The radii of the top-left, top-right, bottom-right and bottom-left corners. */diff --git a/packages/ckeditor5/src/plugins/nested_limit_selection.spec.ts b/packages/ckeditor5/src/plugins/nested_limit_selection.spec.tsindex 0b11961e87..fca20e9066 100644--- a/packages/ckeditor5/src/plugins/nested_limit_selection.spec.ts+++ b/packages/ckeditor5/src/plugins/nested_limit_selection.spec.ts@@ -91,15 +91,17 @@ describe("NestedLimitSelection", () => {it("keeps a page selection inside its column, so a cut keeps the layout", async () => {editor.setData(- "<section class=\"trilium-multicolumn-layout\" data-trilium-column-ratios=\"1-1\">" +- "<section><p>Text</p><figure class=\"table\"><table><tbody><tr><td>Cell</td></tr>" +- "</tbody></table></figure></section>" +- "<section><p>Other</p></section>" +- "</section>"+ "<div class=\"trilium-multicolumn-layout\" data-trilium-column-ratios=\"1-1\">" ++ "<div class=\"trilium-multicolumn-column\">" ++ "<p>Text</p><figure class=\"table\"><table><tbody><tr><td>Cell</td></tr>" ++ "</tbody></table></figure>" ++ "</div>" ++ "<div class=\"trilium-multicolumn-column\"><p>Other</p></div>" ++ "</div>");editor.editing.view.focus();const root = editor.editing.view.getDomRoot();- const text = root?.querySelector(".trilium-multicolumn-layout > section > p")?.firstChild;+ const text = root?.querySelector(".trilium-multicolumn-column > p")?.firstChild;const cellText = findTextNode(root?.querySelector(".trilium-multicolumn-layout td"));expect(text && cellText).toBeTruthy();diff --git a/packages/ckeditor5/src/theme/multicolumn.css b/packages/ckeditor5/src/theme/multicolumn.cssindex 51d44a74c5..e389251680 100644--- a/packages/ckeditor5/src/theme/multicolumn.css+++ b/packages/ckeditor5/src/theme/multicolumn.css@@ -34,7 +34,7 @@grid-template-columns: repeat(4, minmax(0, 1fr));}- & > section {+ & > .trilium-multicolumn-column {padding-block: .75rem;& > :first-child {@@ -55,7 +55,7 @@var(--multicolumn-layout-focus-border-color);}- & > section.ck-editor__nested-editable {+ & > .ck-editor__nested-editable {border: 0;padding-inline: 1rem;box-shadow: none;@@ -64,11 +64,12 @@}@container multicolumn-layout (max-width: 500px) {- .ck-content .trilium-multicolumn-layout > section {+ .ck-content .trilium-multicolumn-layout > .trilium-multicolumn-column {grid-column: 1 / -1;}- .ck-content .trilium-multicolumn-layout.ck-widget > section:nth-of-type(even) {+ .ck-content .trilium-multicolumn-layout.ck-widget+ > :nth-child(even of .trilium-multicolumn-column) {background: var(--multicolumn-layout-stacked-background);}}diff --git a/packages/commons/src/lib/block_reference.spec.ts b/packages/commons/src/lib/block_reference.spec.tsindex 54193bc470..a0e5c13b28 100644--- a/packages/commons/src/lib/block_reference.spec.ts+++ b/packages/commons/src/lib/block_reference.spec.ts@@ -8,6 +8,7 @@ import {getEditableBlockRun,getListItemNumber,isValidBlockId,+ MULTICOLUMN_COLUMN_CLASS,MULTICOLUMN_LAYOUT_CLASS,parseBlockRange,resolveBlockRange,@@ -147,20 +148,20 @@ describe("sliceToBlockReference", () => {it("drops a layout left with one column around the blocks, and keeps one with more", () => {const layout = (...columns: BlockNode[]) =>- el("section", { class: `${MULTICOLUMN_LAYOUT_CLASS} wide` }, ...columns);+ el("div", { class: `${MULTICOLUMN_LAYOUT_CLASS} wide` }, ...columns);const target = block("p", "b", text("B"));const inner = layout(- el("section", {}, el("p", {}, text("A")), target),- el("section", {}, el("p", {}, text("C")))+ layoutColumn(el("p", {}, text("A")), target),+ layoutColumn(el("p", {}, text("C"))));- const root = el("div", {}, layout(el("section", {}, inner), el("section", {})));+ const root = el("div", {}, layout(layoutColumn(inner), layoutColumn()));expect(sliceToBlockReference(root, "b")).toBe(true);expect(render(root)).toBe(`<div>${render(target)}</div>`);const across = layout(- el("section", {}, block("p", "x")),- el("section", {}, block("p", "y"))+ layoutColumn(block("p", "x")),+ layoutColumn(block("p", "y")));const otherRoot = el("div", {}, across);sliceToBlockReference(otherRoot, "x:y");@@ -265,9 +266,9 @@ describe("getEditableBlockRun", () => {it("finds the blocks of a column of a multicolumn layout", () => {const first = block("p", "a");const last = block("p", "b");- const column = el("section", {}, el("p", {}), first, last);+ const column = layoutColumn(el("p", {}), first, last);const root = el("div", {},- el("section", { class: MULTICOLUMN_LAYOUT_CLASS }, column, el("section", {})));+ el("div", { class: MULTICOLUMN_LAYOUT_CLASS }, column, layoutColumn()));expect(getEditableBlockRun(root, "a:b")).toEqual({ parent: column, first, last });});@@ -363,6 +364,10 @@ function el(tagName: string, attributes: Record<string, string>, ...children: Blreturn new TestElement(tagName.toUpperCase(), attributes, children);}+function layoutColumn(...children: BlockNode[]) {+ return el("div", { class: MULTICOLUMN_COLUMN_CLASS }, ...children);+}+function block(tagName: string, id: string, ...children: BlockNode[]) {return el(tagName, { [BLOCK_ID_ATTRIBUTE]: id }, ...children);}diff --git a/packages/commons/src/lib/block_reference.ts b/packages/commons/src/lib/block_reference.tsindex 11c2b66aad..acf866a886 100644--- a/packages/commons/src/lib/block_reference.ts+++ b/packages/commons/src/lib/block_reference.ts@@ -1,9 +1,12 @@/** The HTML attribute with the id of a block in a text note. */export const BLOCK_ID_ATTRIBUTE = "data-trilium-block-id";-/** The class of a multicolumn layout, a `<section>` whose child sections are its columns. */+/** The class of a multicolumn layout, a `<div>` whose child elements are its columns. */export const MULTICOLUMN_LAYOUT_CLASS = "trilium-multicolumn-layout";+/** The class of a column of a multicolumn layout. */+export const MULTICOLUMN_COLUMN_CLASS = "trilium-multicolumn-column";+/** The blocks that a block reference points at. `startId` equals `endId` for a single block. */export interface BlockRange {startId: string;diff --git a/packages/trilium-core/src/services/export/markdown.spec.ts b/packages/trilium-core/src/services/export/markdown.spec.tsindex 5a8410632d..61e9b69972 100644--- a/packages/trilium-core/src/services/export/markdown.spec.ts+++ b/packages/trilium-core/src/services/export/markdown.spec.ts@@ -1020,25 +1020,76 @@ describe("Markdown export", () => {});});- it("exports the columns of a multicolumn layout one after another", () => {- const html =- "<p>Before</p>" +- "<section class=\"trilium-multicolumn-layout\" data-trilium-column-ratios=\"1-3\">" +- "<section><p>First <strong>column</strong></p><ul><li>One</li></ul></section>" +- "<section><h2>Second</h2><p>Text</p></section>" +- "</section>" +- "<p>After</p>";- expect(markdownExportService.toMarkdown(html)).toBe(trimIndentation`\- Before+ describe("multicolumn layouts", () => {+ const column = (content: string) =>+ `<div class="trilium-multicolumn-column">${content}</div>`;+ const layout = (ratios: string, ...columns: string[]) =>+ `<div class="trilium-multicolumn-layout" data-trilium-column-ratios="${ratios}">` ++ `${columns.map(column).join("")}</div>`;++ it("writes each column as Markdown between the HTML tags of the layout", () => {+ const html = `<p>Before</p>${layout("1-3",+ "<p>First <strong>column</strong></p><ul><li>One</li></ul>",+ "<h2>Second</h2><p>Text</p>"+ )}<p>After</p>`;+ expect(markdownExportService.toMarkdown(html)).toBe(trimIndentation`\+ Before++ <div class="trilium-multicolumn-layout" data-trilium-column-ratios="1-3">+ <div class="trilium-multicolumn-column">++ First **column**- First **column**+ * One- * One+ </div>+ <div class="trilium-multicolumn-column">- ## Second+ ## Second- Text+ Text- After`);+ </div>+ </div>++ After`);+ });++ it("keeps a nested layout and the empty columns that Turndown would drop", () => {+ const html = layout("1-1",+ layout("1-2-1", "<p>Inner</p>", "<p> </p>", "<p> </p>"),+ "<p>Outer</p>"+ ) + layout("3-1", "<p> </p>", "<p> </p>");+ expect(markdownExportService.toMarkdown(html)).toBe(trimIndentation`\+ <div class="trilium-multicolumn-layout" data-trilium-column-ratios="1-1">+ <div class="trilium-multicolumn-column">++ <div class="trilium-multicolumn-layout" data-trilium-column-ratios="1-2-1">+ <div class="trilium-multicolumn-column">++ Inner++ </div>+ <div class="trilium-multicolumn-column">+ </div>+ <div class="trilium-multicolumn-column">+ </div>+ </div>++ </div>+ <div class="trilium-multicolumn-column">++ Outer++ </div>+ </div>++ <div class="trilium-multicolumn-layout" data-trilium-column-ratios="3-1">+ <div class="trilium-multicolumn-column">+ </div>+ <div class="trilium-multicolumn-column">+ </div>+ </div>`);+ });});});diff --git a/packages/trilium-core/src/services/export/markdown.ts b/packages/trilium-core/src/services/export/markdown.tsindex 1b7654e0f8..c6883d1111 100644--- a/packages/trilium-core/src/services/export/markdown.ts+++ b/packages/trilium-core/src/services/export/markdown.ts@@ -1,4 +1,6 @@-import { safeLinkPreviewHref, type TaskStateDef } from "@triliumnext/commons";+import {+ MULTICOLUMN_COLUMN_CLASS, MULTICOLUMN_LAYOUT_CLASS, safeLinkPreviewHref, type TaskStateDef+} from "@triliumnext/commons";import { ADMONITION_TYPE_MAPPINGS } from "@triliumnext/commons/src/lib/markdown_renderer.js";import { HIGHLIGHT_BACKGROUND } from "@triliumnext/commons/src/lib/marked_extensions.js";import { gfm, serializeStructuralHtml } from "@triliumnext/turndown-plugin-gfm";@@ -77,6 +79,10 @@ function toMarkdown(content: string, options: ToMarkdownOptions = {}) {return blankTabs;}+ if (isMulticolumnLayout(node) || isMulticolumnColumn(node)) {+ return blankMulticolumnReplacement(node);+ }+// Original implementation as per https://github.com/mixmark-io/turndown/blob/master/src/turndown.js.return ("isBlock" in node && node.isBlock) ? '\n\n' : '';},@@ -88,6 +94,7 @@ function toMarkdown(content: string, options: ToMarkdownOptions = {}) {instance.addRule("details", buildDetailsFilter());instance.addRule("tabTitle", buildTabTitleFilter());instance.addRule("tabPanel", buildTabPanelFilter());+ instance.addRule("multicolumn", buildMulticolumnFilter());instance.addRule("inlineLink", buildInlineLinkFilter());instance.addRule("figure", buildFigureFilter());instance.addRule("linkPreview", buildLinkPreviewFilter());@@ -426,6 +433,55 @@ function buildDetailsFilter(): Rule {};}+/**+ * Exports a multicolumn layout and each of its columns as `<div>` tags on lines of their own, with+ * the Markdown of each column between them. A blank line ends a CommonMark HTML block, so the blank+ * lines inside each column make renderers, the importer included, parse the column as Markdown.+ */+function buildMulticolumnFilter(): Rule {+ return {+ filter(node) {+ return isMulticolumnLayout(node) || isMulticolumnColumn(node);+ },+ replacement(content, node) {+ return multicolumnReplacement(node, content);+ }+ };+}++function multicolumnReplacement(node: Element, content: string): string {+ if (isMulticolumnColumn(node)) {+ const body = content.trim();+ const opening = multicolumnOpeningTag(node);+ return `\n${opening}\n${body ? `\n${body}\n\n` : ""}</div>\n`;+ }+ const opening = multicolumnOpeningTag(node);+ return `\n\n${opening}\n${content.trim()}\n</div>\n\n`;+}++/** Turndown skips the children of a blank element, so this writes the columns of a blank layout. */+function blankMulticolumnReplacement(node: Element): string {+ const columns = isMulticolumnLayout(node)+ ? Array.from(node.children).filter(isMulticolumnColumn)+ .map((column) => multicolumnReplacement(column, "").trim())+ : [];+ return multicolumnReplacement(node, columns.join("\n"));+}++function multicolumnOpeningTag(node: Element): string {+ const attributes = Array.from(node.attributes)+ .map(({ name, value }) => ` ${name}="${escapeHtml(value)}"`);+ return `<div${attributes.join("")}>`;+}++function isMulticolumnLayout(node: Node): boolean {+ return isElement(node) && node.classList.contains(MULTICOLUMN_LAYOUT_CLASS);+}++function isMulticolumnColumn(node: Node): boolean {+ return isElement(node) && node.classList.contains(MULTICOLUMN_COLUMN_CLASS);+}+/** Exports a tab title as the `=== "Title"` line of MkDocs content tabs (`pymdownx.tabbed`). */function buildTabTitleFilter(): Rule {return {diff --git a/packages/trilium-core/src/services/import/markdown.spec.ts b/packages/trilium-core/src/services/import/markdown.spec.tsindex 1646512043..36c0450002 100644--- a/packages/trilium-core/src/services/import/markdown.spec.ts+++ b/packages/trilium-core/src/services/import/markdown.spec.ts@@ -725,4 +725,50 @@ $$`;.toStrictEqual(original);});});++ describe("multicolumn layouts", () => {+ const column = (content: string) =>+ `<div class="trilium-multicolumn-column">${content}</div>`;+ const layout = (ratios: string, ...columns: string[]) =>+ `<div class="trilium-multicolumn-layout" data-trilium-column-ratios="${ratios}">` ++ `${columns.map(column).join("")}</div>`;+ const roundTrip = (html: string) =>+ markdownService.renderToHtml(markdownExportService.toMarkdown(html), "Title");++ it("round-trips layouts through the Markdown exporter unchanged", () => {+ const table = "<figure class=\"table\"><table><tbody>" ++ "<tr><td>a</td><td>b</td></tr>" ++ "</tbody></table></figure>";+ const collapsible = "<details class=\"trilium-collapsible\">" ++ "<summary>S</summary><p>Hidden</p>" ++ "</details>";+ const code = "<pre><code class=\"language-text-x-yaml\">a:\n\n b: 1</code></pre>";+ const original =+ "<p>Before</p>" ++ layout("1-3",+ "<p>First <strong>column</strong></p><ul><li>One</li><li>Two</li></ul>",+ `<h2>Second</h2>${code}`+ ) ++ layout("1-1",+ layout("1-2-1", "<p>Inner</p>", "<p> </p>", table),+ collapsible+ ) ++ layout("3-1", "<p> </p>", "<p> </p>") ++ "<p>After</p>";+ const markdown = markdownExportService.toMarkdown(original);++ expect(roundTrip(original)).toStrictEqual(original);+ expect(markdownExportService.toMarkdown(roundTrip(original))).toStrictEqual(markdown);+ });++ it("round-trips a layout inside a tab panel", () => {+ const twoColumns = layout("1-1", "<p>A</p>", "<p>B</p>");+ const panel = `<div class="trilium-tab-panel">${twoColumns}</div>`;+ const original =+ "<div class=\"trilium-tabs\"><section class=\"trilium-tab\">" ++ `<p class="trilium-tab-title">T</p>${panel}` ++ "</section></div>";+ expect(roundTrip(original)).toStrictEqual(original);+ });+ });});diff --git a/packages/trilium-core/src/services/import/markdown.ts b/packages/trilium-core/src/services/import/markdown.tsindex 3fac6f2ef6..53849bfc50 100644--- a/packages/trilium-core/src/services/import/markdown.ts+++ b/packages/trilium-core/src/services/import/markdown.ts@@ -1,3 +1,4 @@+import { MULTICOLUMN_LAYOUT_CLASS } from "@triliumnext/commons";import { renderToHtml as renderToHtmlShared } from "@triliumnext/commons/src/lib/markdown_renderer.js";import { HTMLElement, Node, NodeType, parse as parseHtml } from "node-html-parser";@@ -18,24 +19,40 @@ export default {};/**- * Restores what the Markdown exporter gives up on a `<details>` block and on a table it keeps as- * raw HTML: the `trilium-collapsible` class, the `<figure class="table">` wrapper, and the absence- * of whitespace between block children, which the exporter indents for readability. All three are- * what CKEditor downcasts, so a note that goes out to Markdown and comes back keeps the content it- * started with instead of changing on its next save.+ * Restores what the Markdown exporter gives up on a `<details>` block, on a table it keeps as raw+ * HTML and on a multicolumn layout: the `trilium-collapsible` class, the `<figure class="table">`+ * wrapper, the paragraph of an empty column, and the absence of whitespace between block children,+ * which the exporter puts on lines of their own for readability. All of them are what CKEditor+ * downcasts, so a note that goes out to Markdown and comes back keeps the content it started with+ * instead of changing on its next save.*/function normalizeToEditorMarkup(html: string): string {- if (!html.includes("<details") && !html.includes("<table")) {+ const hasLayout = html.includes(MULTICOLUMN_LAYOUT_CLASS);+ if (!html.includes("<details") && !html.includes("<table") && !hasLayout) {return html;}const root = parseHtml(html);const collapsibles = root.querySelectorAll("details");const tables = root.querySelectorAll("table");- if (!collapsibles.length && !tables.length) {+ const layouts = hasLayout ? root.querySelectorAll(`.${MULTICOLUMN_LAYOUT_CLASS}`) : [];+ if (!collapsibles.length && !tables.length && !layouts.length) {return html;}+ for (const layout of layouts) {+ removeLayoutWhitespace(layout, NO_CONTAINER_TAGS);+ for (const column of layout.childNodes) {+ if (!(column instanceof HTMLElement)) {+ continue;+ }+ removeLayoutWhitespace(column, NO_CONTAINER_TAGS);+ if (!column.childNodes.length) {+ column.set_content("<p> </p>");+ }+ }+ }+for (const collapsible of collapsibles) {// The plugin builds the element around `class`, so writing the attributes back in that// order keeps a collapsible the user has expanded (`open=""`) byte-identical too.@@ -90,5 +107,7 @@ const COLLAPSIBLE_CLASS = "trilium-collapsible";/** Mirrors `DETAILS_CONTAINER_TAGS` in `services/export/markdown.ts`. */const COLLAPSIBLE_CONTAINER_TAGS = new Set(["DETAILS", "UL", "OL", "LI", "BLOCKQUOTE"]);+const NO_CONTAINER_TAGS = new Set<string>();+/** Mirrors `TABLE_CONTAINER_TAGS` in `@triliumnext/turndown-plugin-gfm`. */const TABLE_CONTAINER_TAGS = new Set(["TABLE", "THEAD", "TBODY", "TFOOT", "TR", "COLGROUP"]);