From a17b445c4f0db3f38f965a7e7a018391d36b6787 Mon Sep 17 00:00:00 2001 From: Matthew Wong Date: Sun, 11 Dec 2022 22:59:30 -0500 Subject: [PATCH] vault backup: 2022-12-11 22:59:30 --- publish/accepted-markdown-metadata.md | 15 +++++++++++++++ ...with-linked-blog-starter-and-github-actions.md | 2 ++ publish/home.md | 11 +++++++---- .../works-out-of-the-box-with-markdown-files.md | 3 ++- 4 files changed, 26 insertions(+), 5 deletions(-) create mode 100644 publish/accepted-markdown-metadata.md diff --git a/publish/accepted-markdown-metadata.md b/publish/accepted-markdown-metadata.md new file mode 100644 index 0000000..02cf35c --- /dev/null +++ b/publish/accepted-markdown-metadata.md @@ -0,0 +1,15 @@ +--- +title: "Accepted Metadata for Markdown Files" +--- + +Here are all the metadata fields accepted by the linked-blog-starter-md template. All fields are optional. +``` +title: "Title of Note" +excerpt: "Excerpt shown in note preview + SEO" +date: "2021-11-11" +author: + name: "Matthew Wong" + url: "URL to a pic for the author" +ogImage: + url: "URL to an image to set the og Image for SEO" +``` \ No newline at end of file diff --git a/publish/deploy-obsidian-notes-with-linked-blog-starter-and-github-actions.md b/publish/deploy-obsidian-notes-with-linked-blog-starter-and-github-actions.md index 7a4eae9..729530b 100644 --- a/publish/deploy-obsidian-notes-with-linked-blog-starter-and-github-actions.md +++ b/publish/deploy-obsidian-notes-with-linked-blog-starter-and-github-actions.md @@ -18,6 +18,8 @@ By the end of this tutorial, you'll have a github repository that will automatic ![[enable-actions-github.png]] 10. Now whenever any notes are uploaded to the `publish` directory of the repository, they are automatically published online! You can find the domain in Vercel under `Projects`. +**Note**: Make sure you don't delete the `/publish/home.md` file as that is your "landing page" + Additional Readings - [[connect-obsidian-vault-with-github|How to connect Obsidian with Github]] - [[update-publish-settings-github-actions|Updating the publish settings]] diff --git a/publish/home.md b/publish/home.md index e9c7f90..e52e38c 100644 --- a/publish/home.md +++ b/publish/home.md @@ -3,16 +3,19 @@ title: "Home" --- # Host your second brain with Next.JS -This repository is a modified version of the [blog-starter](https://github.com/vercel/next.js/tree/canary/examples/blog-starter) provided by Next.JS. Below are some added features of the [linked-blog-starter](https://github.com/matthewwong525/linked-blog-starter): +This repository is a modified version of the blog starter provided by Next. JS. Below are some added features of the [linked-blog-starter](https://github.com/matthewwong525/linked-blog-starter): - Automatically generated backlinks and link previews -- [[works-out-of-the-box-with-markdown-files|Works out of the box]] with your markdown files +- [[works-out-of-the-box-with-markdown-files|Works out of the box]] with your markdown files (No configuration needed) - Supports markdown & Obsidian specific markdown syntax (via [obsidian-export](https://github.com/zoni/obsidian-export)) - Highly customizable with Next.js, Tailwind v3 and React ## How to use this with Obsidian markdown files -To use this with Obsidian, you'll need to use [obsidian-export](https://github.com/zoni/obsidian-export) to [[convert-obsidian-notes-to-common-markdown|convert your obsidian notes to common markdown]] format. Once in the common markdown format, add the markdown files to the `/common_md` folder and the blog posts will be created. +To use this with Obsidian, you'll need to use [obsidian-export](https://github.com/zoni/obsidian-export) to [[convert-obsidian-notes-to-common-markdown|convert your obsidian notes to a common markdown]] format. Once in the common markdown format, add the markdown files to the `/common_md` folder and the blog posts will be created. -If you are tired of constantly running obsidian-export and manually deploying, see how I [[deploy-obsidian-notes-with-linked-blog-starter-and-github-actions|automate this process with GitHub actions]] +Here are the external libraries I used to help me convert Obsidian markdown files to beautiful HTML: +- [obsidian-export](https://github.com/zoni/obsidian-export) (Obsidian MD -> [Common MD](https://commonmark.org/)) +- [remarkjs](https://github.com/remarkjs/remark) (Common MD -> HTML) +- [github-markdown-css](https://github.com/sindresorhus/github-markdown-css) (HTML -> Beautiful HTML) ## Demo diff --git a/publish/works-out-of-the-box-with-markdown-files.md b/publish/works-out-of-the-box-with-markdown-files.md index 5abbc90..585b27e 100644 --- a/publish/works-out-of-the-box-with-markdown-files.md +++ b/publish/works-out-of-the-box-with-markdown-files.md @@ -1,2 +1,3 @@ - URL paths are generated based on the folder structure and file names -- Links to attachments automatically work \ No newline at end of file +- Links to attachments/images automatically work +- [[accepted-markdown-metadata|Metadata]] can also be passed into the blog \ No newline at end of file