jeffemmett
/
linked-blog-starter-md
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

vault backup: 2022-12-12 13:56:17

This commit is contained in:
Matthew Wong 2022-12-12 13:56:17 -05:00
parent ac75f66233
commit dde0ce6aea
1 changed files with 15 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
publish/home.md
View File

@ -3,19 +3,22 @@ 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](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 (No configuration needed)
- Supports markdown & Obsidian specific markdown syntax (via [obsidian-export](https://github.com/zoni/obsidian-export))
- Embed "PreviewLinks" outside of the markdown files (See the footer in the [example](https://linked-blog-starter.vercel.app/home))
- Easily [[publish-your-obsidian-notes-with-linked-blog-starter|extend upon this repository]] and publish your notes
## 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.
## 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|customize]], difficult to publish, and tend to [[linked-blog-starter-does-not-reinvent-wheel|reinvent the 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|setting everything up:]]
1. Write a note in `/publish` folder within Obsidian
2. Run the backup command [[connect-obsidian-vault-with-github|using the Obsidian Git plugin]]
3. Done. Your notes are published.
## 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/)