forked from jackyzha0/quartz
-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated the README with the step by step instructions
- Loading branch information
1 parent
8878605
commit fd6f366
Showing
1 changed file
with
48 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,54 @@ | ||
# Quartz v4 | ||
# Front Porch v1 (a fork of [Quartz](https://quartz.jzhao.xyz/)) | ||
|
||
> “[One] who works with the door open gets all kinds of interruptions, but [they] also occasionally gets clues as to what the world is and what might be important.” — Richard Hamming | ||
## Prerequisites | ||
|
||
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. | ||
Quartz v4 features a from-the-ground rewrite focusing on end-user extensibility and ease-of-use. | ||
> "Quartz requires **at least [Node](https://nodejs.org/) v18.14** and `npm` v9.3.1 to function correctly. Ensure you have this installed on your machine before continuing" | ||
🔗 Read the documentation and get started: https://quartz.jzhao.xyz/ | ||
## Instructions | ||
|
||
[Join the Discord Community](https://discord.gg/cRFFHYye7t) | ||
### Step 1 - Fork the Front Porch Repo and use the following format for its name: | ||
|
||
## Sponsors | ||
[your github username].github.io | ||
|
||
<p align="center"> | ||
<a href="https://github.com/sponsors/jackyzha0"> | ||
<img src="https://cdn.jsdelivr.net/gh/jackyzha0/jackyzha0/sponsorkit/sponsors.svg" /> | ||
</a> | ||
</p> | ||
For me, that was joshwingreene.github.io. | ||
|
||
I recommend that you keep the "Copy the main branch only" option checked. | ||
|
||
### Step 2 - Clone your fork to your machine | ||
|
||
I recommend that you place it in your Obsidian vault. | ||
|
||
For reference, I have a folder called "My Digital Garden" and I have the following two sub-folders inside of it: | ||
- Publisher | ||
- Workbench | ||
|
||
I cloned my fork repo into the "Publisher" folder. | ||
|
||
### Step 3 - Use the terminal in order to navigate to your front porch folder and then run `npm install` in order to install all of the necessary packages. The dependencies of Front Porch v1.0.0 is consistent with the dependencies that Quartz v4.2.3 relies on. | ||
|
||
**Step 4 Disclaimer:** "I am not a lawyer, and the information provided is not legal advice. Please consult a qualified legal professional for legal advice specific to your situation." | ||
|
||
### Step 4 - Navigate to the LICENSE.txt file and add a line to the top of the file under "MIT" | ||
|
||
Copyright (c) <your name without the carets> | ||
|
||
### Step 5 - Navigate to the quartz.config.ts file and update lines 17 to 59 accordingly | ||
|
||
### Step 6 - Update the images in the static folder | ||
|
||
### Step 7 - Follow the following steps from Quartz to host your front porch on github | ||
|
||
> 1. Head to “Settings” tab of your forked repository and in the sidebar, click “Pages”. Under “Source”, select “GitHub Actions”. | ||
> 2. Commit these changes by doing npx quartz sync. This should deploy your site to <github-username>.github.io/<repository-name>. | ||
The deploy.yml file was added for you. | ||
|
||
Reference: [Hosting](https://quartz.jzhao.xyz/hosting#github-pages) | ||
|
||
### Step 8 - Add a custom domain | ||
|
||
Follow the steps that Quartz provides: | ||
|
||
[Custom Domains](https://quartz.jzhao.xyz/hosting#custom-domain) | ||
|
||
### Step 9 - Enjoy! |