diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 7d4ca9b..b8b11cd 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -41,3 +41,4 @@ jobs: vercel-token: ${{ secrets.VERCEL_TOKEN }} # Required vercel-org-id: ${{ secrets.VERCEL_ORG_ID }} # Required vercel-project-id: ${{ secrets.VERCEL_PROJECT_ID }} # Required + vercel-args: '--prod' #Optional diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..25da6e6 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.obsidian \ No newline at end of file diff --git a/publish/README.md b/publish/README.md index 27583fe..67b17d2 100644 --- a/publish/README.md +++ b/publish/README.md @@ -1,2 +1,34 @@ -# linked-blog-md -Markdown files for the linked-blog-starter repository +# 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): +- Automatically generated backlinks and link previews +- [[works-out-of-the-box-with-markdown-files|Works out of the box]] with your markdown files +- 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. + +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]] + +## Demo + +[https://linked-blog-starter.vercel.app/](https://linked-blog-starter.vercel.app/) + +## Deploy your own + +Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) or preview live with [StackBlitz](https://stackblitz.com/github/matthewwong525/linked-blog-starter) + +[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/blog-starter&project-name=blog-starter&repository-name=blog-starter) + +### Related examples +- [Fleeting Notes](https://fleetingnotes.app) + +## [[install-linked-blog-starter|Installation]] +![[install-linked-blog-starter]] + +# Notes +- `linked-blog-starter` uses [Tailwind CSS](https://tailwindcss.com) [(v3.0)](https://tailwindcss.com/blog/tailwindcss-v3). +- Markdown files are statically generated +- Html is generated using [generated GitHub flavoured markdown](https://github.com/sindresorhus/github-markdown-css) + diff --git a/publish/notes/install-linked-blog-starter.md b/publish/notes/install-linked-blog-starter.md new file mode 100644 index 0000000..860835a --- /dev/null +++ b/publish/notes/install-linked-blog-starter.md @@ -0,0 +1,4 @@ +1. Clone this repo by runningĀ `git clone https://github.com/matthewwong525/linked-blog-starter` +2. `cd linked-blog-starter` +3. `npm install` +4. `npm run dev` \ No newline at end of file diff --git a/publish/notes/works-out-of-the-box-with-markdown-files.md b/publish/notes/works-out-of-the-box-with-markdown-files.md new file mode 100644 index 0000000..5abbc90 --- /dev/null +++ b/publish/notes/works-out-of-the-box-with-markdown-files.md @@ -0,0 +1,2 @@ +- URL paths are generated based on the folder structure and file names +- Links to attachments automatically work \ No newline at end of file diff --git a/publish/posts/convert-obsidian-notes-to-common-markdown.md b/publish/posts/convert-obsidian-notes-to-common-markdown.md new file mode 100644 index 0000000..0658ea0 --- /dev/null +++ b/publish/posts/convert-obsidian-notes-to-common-markdown.md @@ -0,0 +1 @@ +Placeholer \ No newline at end of file diff --git a/publish/posts/deploy-obsidian-notes-with-linked-blog-starter-and-github-actions.md b/publish/posts/deploy-obsidian-notes-with-linked-blog-starter-and-github-actions.md new file mode 100644 index 0000000..f6e0339 --- /dev/null +++ b/publish/posts/deploy-obsidian-notes-with-linked-blog-starter-and-github-actions.md @@ -0,0 +1 @@ +Placeholder \ No newline at end of file