quartz/README.md

🌱 Forgetful Notes

Overview

This repository holds 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.

Table of Contents

Show/Hide

• Overview
• Table of Contents
• Screenshots
  • Full Width
  • Slim (light)
  • Slim (dark)
• Useful Commands
  • Install Dependencies
  • Update Dependencies
  • Start Local Server
  • Update Quartz
  • Sync the Repo
  • Build Only
  • Find Help
• Customization
  • Stylesheets
  • Fonts
• Folder Structure
• Acknowledgements and Attributions
• License

Screenshots

Show/Hide

Full Width

Slim (light)

Slim (dark)

Useful Commands

Each line within codeblocks represents different ways to achieve the same result. This means that you can, for example, use either npm i or npm install when installing dependencies.

Install Dependencies

npm i
# npm install

Update Dependencies

npm update

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

Customization

Stylesheets

You can add custom CSS code within /quartz/styles/custom.scss. You will then need to uncomment line 4 of /quartz/styles/base.scss to have it take effect.

Fonts

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

Folder Structure

Show/Hide

.
├── .github/
│   └── workflows/
│       ├── build.yml
│       └── deploy.yml
├── content/
│   ├── notes.md
│   ├── pages.md
│   └── ...
├── docs/
│   ├── documentation.md
│   └── ...
├── quartz/
│   ├── cli/
│   │   ├── args.js
│   │   ├── constants.js
│   │   ├── handlers.js
│   │   └── helpers.js
│   ├── components/
│   │   ├── pages/
│   │   ├── scripts/
│   │   ├── styles/
│   │   ├── Backlinks.tsx
│   │   ├── Explorer.tsx
│   │   └── ...
│   ├── plugins/
│   │   ├── emitters/
│   │   ├── filters/
│   │   ├── transformers/
│   │   ├── index.ts
│   │   ├── types.ts
│   │   └── vfile.ts
│   ├── processors/
│   │   ├── emit.ts
│   │   ├── filter.ts
│   │   └── parse.ts
│   ├── static/
│   │   ├── favicon.ico
│   │   ├── site.manifest
│   │   └── ...
│   ├── styles/
│   │   ├── base.scss
│   │   ├── callouts.scss
│   │   ├── custom.scss
│   │   ├── syntax.scss
│   │   └── variables.scss
│   ├── util/
│   │   ├── theme.ts
│   │   ├── jsx.tsx
│   │   └── ...
│   ├── bootstrp.cli.mjs
│   ├── bootstrap-worker.njs
│   ├── build.ts
│   ├── cfg.ts
│   └── worker.ts
├── .gitattributes
├── .gitignore
├── .npmrc
├── .prettierignore
├── .prettierrc
├── Dockerfile
├── LICENSE
├── README.md
├── globals.d.ts
├── index.d.ts
├── package-lock.json
├── package.json
├── quartz.config.ts
├── quartz.layout.ts
├── screenshot.png
└── tsconfig.json

Acknowledgements and Attributions

Forgetful Notes is based on Quartz.

License

Source code in this repository is available under the MIT License.