Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sosiristseng/template-quartz
Template for publishing Obsidian note for free, powered by https://github.com/jackyzha0/quartz
https://github.com/sosiristseng/template-quartz
digital-garden github-pages markdown obsidian template
Last synced: 6 days ago
JSON representation
Template for publishing Obsidian note for free, powered by https://github.com/jackyzha0/quartz
- Host: GitHub
- URL: https://github.com/sosiristseng/template-quartz
- Owner: sosiristseng
- License: mit
- Created: 2023-08-22T01:56:35.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-30T01:07:06.000Z (18 days ago)
- Last Synced: 2024-10-30T03:52:07.229Z (18 days ago)
- Topics: digital-garden, github-pages, markdown, obsidian, template
- Language: TypeScript
- Homepage: https://sosiristseng.github.io/template-quartz/
- Size: 405 KB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Quartz v4 Template for GitHub pages
[Quartz][] is a set of tools that helps you publish your [digital garden](https://jzhao.xyz/posts/networked-thought) and notes as a website for free.
This template repository
- uses [Quartz][] by Jacky Zhao as a git submodule to catch up its rapid development.
- builds the website from the notes and publishes to GitHub pages by GitHub actions.
- is [Obsidian](https://obsidian.md/)-friendly (thanks to [Quartz][]). Just open the `content` folder in Obsidian.
[Quartz]: https://github.com/jackyzha0/quartz
## Easiest way to use (without using Quartz locally)
Click the big green `Use this template` button to create a repository. Clone the created repository using GitHub Desktop or `git clone` command:
```bash
git clone https://github.com//.git
```
Open the `content` folder in Obsidian, edit/add notes and use GitHub Desktop or `git push` command to commit and push the changes to GitHub. GitHub actions will build and publish the website automatically.
> [!IMPORTANT]
> You need to enable GitHub pages in your repository settings -> pages -> selecting `GitHub actions` as the source.
## How to use Quartz locally
Click the big green `Use this template` button to create a repository.
Since this repository has [Quartz][] as a submodule, if you want to use quartz to build/preview the website, you need to clone both the repository and the submodule:
```bash
git clone --recursive https://github.com//.git
```
To run Quartz in preview mode (See [Building your Quartz](https://quartz.jzhao.xyz/build) for details)
```bash
cd quartz
npm i
npx quartz build -d ../content --serve
```
You can open the `content` folder in Obsidian (or other editors) to edit/add your notes. After that, use GitHub Desktop or `git push` command to commit and push the changes to GitHub. GitHub actions will build and publish the website automatically.
> [!IMPORTANT]
> You need to enable GitHub pages in your repository settings -> pages -> selecting `GitHub actions` as the source.
## Cloudflare pages
[Cloudflare pages](https://dash.cloudflare.com/) build configurations:
- Framework preset: `None`
- Build command : `cp quartz.config.ts quartz.layout.ts quartz/ && cd quartz && npm ci && npx quartz build --directory ../content`
- Build output directory: `quartz/public`