Skip to content

A fully open source & end-to-end encrypted note taking alternative to Evernote.

core: add new md + frontmatter export format

Abdullah Atta3eeb292d70b1
diff --git a/packages/core/src/models/note.js b/packages/core/src/models/note.js
index 2ab445f52..621c882f8 100644
--- a/packages/core/src/models/note.js
+++ b/packages/core/src/models/note.js
@@ -17,7 +17,7 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-import MarkdownBuilder from "../utils/templates/markdown/builder";
+import * as MarkdownBuilder from "../utils/templates/markdown/builder";
import HTMLBuilder from "../utils/templates/html/builder";
import TextBuilder from "../utils/templates/text/builder";
import { getContentFromData } from "../content-types";
@@ -79,7 +79,7 @@ export default class Note {
/**
*
- * @param {"html"|"md"|"txt"} format - Format to export into
+ * @param {"html"|"md"|"md-frontmatter"|"txt"} format - Format to export into
* @param {string} [contentItem=undefined]
* @param {boolean} [template=true]
* @param {string} [rawHTML=undefined] rawHTML - Use this raw content instead of generating itself
@@ -132,6 +132,11 @@ export default class Note {
return template
? MarkdownBuilder.buildMarkdown(templateData)
: templateData.content;
+ case "md-frontmatter":
+ templateData.content = rawHTML || content.toMD();
+ return template
+ ? MarkdownBuilder.buildMarkdownWithFrontmatter(templateData)
+ : templateData.content;
default:
throw new Error("Export format not supported.");
}
diff --git a/packages/core/src/utils/templates/html/template.js b/packages/core/src/utils/templates/html/template.js
index 88657930e..de2e1dc49 100644
--- a/packages/core/src/utils/templates/html/template.js
+++ b/packages/core/src/utils/templates/html/template.js
@@ -27,8 +27,13 @@ const template = (data) => `<!DOCTYPE html>
content="${data.headline}"
/>
<title>${data.title} - Notesnook</title>
- <meta name="created-on" content="${data.createdOn}" />
- <meta name="last-edited-on" content="${data.editedOn}" />
+ <meta name="created-at" content="${data.createdOn}" />
+ <meta name="updated-at" content="${data.editedOn}" />
+ ${data.pinned ? `<meta name="pinned" content="${data.pinned}" />` : ""}
+ ${
+ data.favorite ? `<meta name="favorite" content="${data.favorite}" />` : ""
+ }
+ ${data.color ? `<meta name="color" content="${data.color}" />` : ""}
${data.tags ? `<meta name="tags" content="${data.tags}" />` : ""}
<link rel="stylesheet" href="https://app.notesnook.com/assets/editor-styles.css?d=${
process.env.NN_BUILD_TIMESTAMP || "1690887574068"
diff --git a/packages/core/src/utils/templates/markdown/builder.js b/packages/core/src/utils/templates/markdown/builder.js
index c3838b1e2..75dceea9e 100644
--- a/packages/core/src/utils/templates/markdown/builder.js
+++ b/packages/core/src/utils/templates/markdown/builder.js
@@ -17,10 +17,7 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-import MDTemplate from "./template";
-
-function buildMarkdown(templateData) {
- return MDTemplate(templateData);
-}
-
-export default { buildMarkdown };
+export {
+ template as buildMarkdown,
+ templateWithFrontmatter as buildMarkdownWithFrontmatter
+} from "./template";
diff --git a/packages/core/src/utils/templates/markdown/template.js b/packages/core/src/utils/templates/markdown/template.js
index 49ca7cde6..9889e66e7 100644
--- a/packages/core/src/utils/templates/markdown/template.js
+++ b/packages/core/src/utils/templates/markdown/template.js
@@ -17,10 +17,20 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-const template = (data) => `# ${data.title}
+export const template = (data) => `# ${data.title}
-${data.content}
+${data.content}`;
+
+export const templateWithFrontmatter = (data) => `---
+title: ${JSON.stringify(data.title || "")}
+created_at: ${data.createdOn}
+updated_at: ${data.editedOn}
+pinned: ${data.metadata.pinned}
+favorite: ${data.metadata.favorite}
+color: ${data.metadata.color}
+tags: ${data.tags}
---
-${data.tags ? `${data.tags}` : ""}`;
-export default template;
+# ${data.title}
+
+${data.content}`;