mirror of https://github.com/jackyzha0/quartz.git synced 2026-03-24 15:05:42 -05:00

🌱 a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites

digital-garden networked-thought obsidian obsidian-md quartz-ssg static-site-generator

Go to file

semanticdata 6e13d50d48 add package run scripts		2024-01-30 13:33:05 -06:00
.github	Merge branch 'v4' of https://github.com/jackyzha0/quartz	2024-01-28 10:40:53 -06:00
content	Update content/index.md	2024-01-30 08:35:17 -08:00
docs	Merge branch 'v4' of https://github.com/jackyzha0/quartz	2024-01-28 10:40:53 -06:00
quartz	Merge branch 'v4' of https://github.com/jackyzha0/quartz	2024-01-30 13:23:48 -06:00
.gitattributes	rgb to hex colors	2023-09-21 17:49:02 -05:00
.gitignore	Quartz sync: Dec 3, 2023, 5:10 PM	2023-12-03 17:10:25 -06:00
.npmrc	add engines field	2023-08-20 08:57:56 -07:00
.prettierignore	fix notes	2023-08-07 23:57:24 -07:00
.prettierrc	Use semi: false for prettier config	2022-05-02 08:57:25 -07:00
Dockerfile	Create Dockerfile	2023-10-10 18:12:23 -05:00
globals.d.ts	fix(type): make sure dispatchEvent also accept UIEvent (#760 )	2024-01-29 16:26:47 -08:00
index.d.ts	feat: Emit custom event when theme changes (#723 )	2024-01-23 14:52:41 -08:00
LICENSE	adjust layout, moves desktop backlinks, add toc	2023-11-23 14:06:38 -06:00
package-lock.json	chore(deps): bump workerpool from 8.0.0 to 9.1.0 (#757 )	2024-01-29 12:45:37 -08:00
package.json	add package run scripts	2024-01-30 13:33:05 -06:00
quartz.config.ts	docs: clarify git only sets modified	2024-01-07 15:39:38 -08:00
quartz.layout.ts	fix build issue with search	2024-01-19 10:46:44 -06:00
README.md	add package run scripts	2024-01-30 13:33:05 -06:00
screenshot-dark.png	Quartz sync: Dec 3, 2023, 5:10 PM	2023-12-03 17:10:25 -06:00
screenshot-full.png	Quartz sync: Dec 3, 2023, 5:10 PM	2023-12-03 17:10:25 -06:00
screenshot-light.png	Quartz sync: Dec 3, 2023, 5:10 PM	2023-12-03 17:10:25 -06:00
tsconfig.json	run prettier	2023-07-22 17:27:41 -07:00

README.md

🌱 Forgetful Notes

code size repository size commits last commit is website up?

Overview

This is the source code for Forgetful Notes—my digital garden of knowledge. It serves as a platform for my learning and creative endeavours. A space for thinking through, building upon, and coming back to.

It is powered by Quartz and Obsidian. You can read the Documentation, and join the Discord Community.

Show/Hide

Overview
Table of Contents
Screenshots
Useful Commands
Style
- Fonts
License

Screenshots

Full Width

Slim (light)

Slim (dark)

Useful Commands

Description	Command
Install Dependencies	`npm i`
Update Dependencies	`npm update`
Update Quartz (core)	`npx quartz update`
Build only	`npx quartz build`
Build and Serve	`npx quartz build --serve`
Sync Local Changes	`npx quartz sync`
Find Help	`npx quartz sync --help`

Install Dependencies

npm i
npm install

Start Local Server

npm start
npm run start
npx quartz build --serve

Update Quartz

npm run update
npx quartz update

Sync the Repo

npm run sync
npx quartz sync

Build Only

npm run build
npx quartz build

Find Help

npx quartz --help
npx quartz <command> --help

Style

Fonts

Used in:	Font Family	Previous Font
Headers	Bitter	Schibsted Grotesk
Body	Bitter	Source Sans Pro
Code	Fira Mono	IBM Plex Mono

License

Source code in this repository is available under the MIT license. You are free to use this code however you see fit. That said, some acknowledgement would be well received.