Notepad/enter/About Obsidian/Obsidian Guides/Quartz.md

42 lines
2.1 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

Quartz is a static site generator that is specifically for markdown files. This can be quite fast and there is a bunch of documentation written about this already.
Something to consider as an alternative to Digital Garden plugins. It seems to be more robust as well. Originally found via [this reddit post.](https://www.reddit.com/r/ObsidianMD/comments/1foxvvb/publish_vault_for_free_with_quartz/?chainedPosts=t3_ky0vkg)
- [Quartz Showcase](https://quartz.jzhao.xyz/showcase)
- discovered originally by [this user who made his personal site](https://y9san9.me) through quartz & obsidian
- Quartz made by the [person](https://jzhao.xyz) himself! A wonderful blog and website
- This is a [pretty nice guide](https://notes.nicolevanderhoeven.com/How+to+publish+Obsidian+notes+with+Quartz+on+GitHub+Pages) on how to use Quartz to publish to Github Pages
- For what it's worth there also seems to be Quartz Publish as a plugin
- this was used in the [share notes site](https://docs.note.sx)
---
# Guide to connect Quartz with Web Host:
[Full Link](https://quartz.jzhao.xyz/hosting)
### Deploy to Vercel
1. Log in to the [Vercel Dashboard](https://vercel.com/dashboard) and click “Add New…” > Project
2. Import the Git repository containing your Quartz project.
3. Give the project a name (lowercase characters and hyphens only)
4. Check that these configuration options are set:
|Configuration option|Value|
|---|---|
|Framework Preset|`Other`|
|Root Directory|`./`|
|Build and Output Settings > Build Command|`npx quartz build`|
5. Press Deploy. Once its live, youll have 2 `*.vercel.app` URLs to view the page
### Netlify
1. Log in to the [Netlify dashboard](https://app.netlify.com/) and click “Add new site”.
2. Select your Git provider and repository containing your Quartz project.
3. Under “Build command”, enter `npx quartz build`.
4. Under “Publish directory”, enter `public`.
5. Press Deploy. Once its live, youll have a `*.netlify.app` URL to view the page.
6. To add a custom domain, check “Domain management” in the left sidebar, just like with Vercel.