linked-blog-starter-md/publish/home.md

2.4 KiB

title
A Customizable Obsidian Publish alternative using Next.JS

A Customizable Obsidian Publish alternative using Next.JS

This repository is a modified version of the blog starter provided by Next.JS. Below are some added features of the linked-blog-starter:

  • Automatically generated backlinks and link previews
  • works-out-of-the-box-with-markdown-files with your markdown files (No configuration needed)
  • Supports markdown & Obsidian specific markdown syntax (via obsidian-export)
  • Embed "PreviewLinks" outside of the markdown files (See the footer in the example)
  • Highly customizable with Next.js, Tailwind v3 and React

Why I created this?

It's true that there are many Obsidian Publish alternatives, but, many of these solutions are hard to deploy-a-custom-linked-blog-starter, difficult to publish, and tend to linked-blog-starter-does-not-reinvent-wheel. With this repository, I want to create a simple template that takes care of everything. Here's what the publish workflow looks like after publish-your-obsidian-notes-with-linked-blog-starter

  1. Write a note in /publish folder within Obsidian
  2. Run the backup command connect-obsidian-vault-with-github
  3. Done. Your notes are published.

Demo

https://linked-blog-starter.vercel.app/

Deploy your own

Only deploy through this method, if you want to get a quick server up and running. Otherwise, I'd recommend following the publish-your-obsidian-notes-with-linked-blog-starter.

Deploy the example using Vercel or preview live with StackBlitz

Create a Custom Fork

Here is an example of how I forked this repo to create a landing page for Fleeting Notes. See how you can do something similar deploy-a-custom-linked-blog-starter.

!fn-website-demo.gif