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

37 lines
2.9 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
title: "A Customizable Obsidian Publish alternative using Next.JS"
---
# A Customizable Obsidian Publish alternative using Next.JS
## Problems with Obsidian Publish Alternatives (from ChatGPT):
> **Compatibility**: Not all Obsidian Publish alternatives may be compatible with all versions of Obsidian or all markdown syntax, which can make it difficult to use certain tools or services.
>
> **Ease of use:** Some Obsidian Publish alternatives may be more difficult to set up or use than others, which can make it frustrating for new users to get started.
>
> **Customization**: Some Obsidian Publish alternatives may not offer as much customization as users may want, making it difficult to tailor the appearance and functionality of their published notes to their specific needs and preferences.
>
> **Performance**: Some Obsidian Publish alternatives may not perform as quickly or smoothly as users may expect, which can make it frustrating to use.
## Here's the linked-blog-starter addresses these problems:
- **Compatibility:** External / extensible libraries are used to convert Obsidian MD files to common markdown then to HTML
- **Ease of Use**: Obsidian notes [[works-out-of-the-box-with-markdown-files|work out of the box]] and after the [[publish-your-obsidian-notes-with-linked-blog-starter|setup]], publishing notes is done in 2 steps:
1. Write a note in `/publish` folder within Obsidian
2. Run the backup command [[connect-obsidian-vault-with-github|using the Obsidian Git plugin]]
- **Customization:** [[deploy-a-custom-linked-blog-starter|Create your own template]] or use someone else's! Changing the template is simple matter of [[update-publish-settings-github-actions|updating one line in your repository]]. There's also an added feature to add "PreviewLinks" to text outside of markdown files. (See the footer in the [example](https://linked-blog-starter.vercel.app/home))
- **Performance:** All markdown files are [[statically-generated|statically generated]] meaning loading speeds are super speedy!
## Demo
[https://linked-blog-starter.vercel.app/](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|instructions to integrate this with your Obsidian Vault]].
Deploy the example using [Vercel](https://vercel.com/new/git/external?repository-url=https://github.com/matthewwong525/linked-blog-starter&project-name=linked-blog-starter&repository-name=linked-blog-starter) or preview live with [StackBlitz](https://stackblitz.com/github/matthewwong525/linked-blog-starter)
## Create a Custom Fork
Here is an example of how I [forked this repo](https://github.com/fleetingnotes/fleeting-notes-website) to create a landing page for [Fleeting Notes](https://www.fleetingnotes.app/). See how you can do something similar [[deploy-a-custom-linked-blog-starter|here]].
![[fn-website-demo.gif]]