šŸ‘±šŸ»ā¤ļøā˜•.

Deploy a custom version of the linked-blog-starter

By the end of this tutorial, you will have a custom version of the linked-blog-starter that deploys to Vercel

Fork the repository and get it to run locally

First, we want to fork the linked-blog-starter repo, then installInstall linked-blog-starter locally1. Clone this repo by runningĀ git clone https://github.com/matthewwong525/linked-blog-starter 1. cd linked-blog-starter 1. npm install 1. npm run dev 1. Go to localhost:3000 in your browser and run it locally.

Note: Update https://github.com/matthewwong525/linked-blog-starter with your own repository link

  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
  5. Go to localhost:3000 in your browser

After doing the installations, you can update the components as you wish.

Make changes to the forked repository

Here are the docs for Next.JS and a few things to know about:

  • Update /next.config.js to update the redirects
  • Use /components/misc/preview-link.tsx to add link previews to any text on hover
  • The fleeting-notes-website repository is a fork with lots of good examples (including, post-list, comments, etc.)
  • The /common_md/ directory is where the markdown files are stored in the common markdown format. Use obsidian-export to convert your notes to common markdown

Publish the repository and link it with an MD repository

  1. Create and publishPublish your Obsidian Notes with linked-blog-starterBy the end of this tutorial, you'll have a github repository that will automatically publish notes to your custom website everytime you upload new notes to the publish folder. Step-by-step instructions to setup your blog 1. Fork the repository linked-blog-starter-md repository. This repository is where the publishing occurs fork-linked-blog-starter-md.png 1. Create a Vercel account then go to your dashboard then (Add New... > Project) 1. Import the repository you just forked 1. In the "Con your forked md repository
  2. Update the "BLOG_REPO" environment variableUpdate the Publish SettingsThere are two things you can modify in the workflow. The publish directory and the blog repository. * BLOG_REPO: Next.JS app repository template that is used to publish your markdown notes. This is useful when you create your own custom linked blog * PUBLISH_DIR: The folder that is published to the linked blog. All files and attachments in this folder will be published on the web Go into .github/workflows/publish.yml in your forked repository forked from linked-blog-starter-md and update the to point to your forked repo
  3. OPTIONAL: Connect your Obsidian Vault with GithubHow to connect Obsidian Vault with Github1. Clone the repository or "Download As Zip" clone-or-download-github.png 1. Unzip the downloaded folder, then open the folder as a vault in Obsidian 1. Install the Obsidian Git community plugin 1. To publish your notes run the command "Obsidian Git: Create backup" by opening the command palette (CMD/Ctrl + P)