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.
https://github.com/matthewwong525/linked-blog-starter with your own repository link
- Clone this repo by running
git clone https://github.com/matthewwong525/linked-blog-starter
npm run dev
- 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:
/next.config.js to update the redirects
/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.)
/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
- 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
1. Create a Vercel account then go to your dashboard then (Add New... > Project)
1. your forked md repository
- 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
- OPTIONAL: Connect your Obsidian Vault with GithubThe Easiest Way to Connect Your Obsidian Vault with GithubI watched a few videos on how to setup the obsidian-git plugin and it feels like most of them overcomplicate the process. So I decided to write a set of instructions and a video to show how easy it to accomplish this even if you have no idea what "git" is.
By the end of this tutorial, you will be able to sync your notes from Obsidian to Github for free!
1. Create a repository or fork the md repo in github
1. Download Git
1. Create a personal access token from git