🌱 a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites
Go to file
2024-03-06 15:45:17 -06:00
.github Merge branch 'v4' of https://github.com/jackyzha0/quartz 2024-02-26 12:04:03 -06:00
content add data note to check footnotes 2024-03-06 13:36:01 -06:00
docs Merge branch 'v4' of https://github.com/jackyzha0/quartz 2024-03-06 13:36:48 -06:00
quartz Merge branch 'v4' of https://github.com/jackyzha0/quartz 2024-03-06 13:36: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 add lock file to ignore 2024-02-23 10:48:29 -06: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 chore: add window.addCleanup() for cleaning up handlers 2024-02-01 21:19:51 -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-dev): bump @types/node from 20.11.19 to 20.11.24 (#958) 2024-03-05 21:59:37 -08:00
package.json chore(deps-dev): bump @types/node from 20.11.19 to 20.11.24 (#958) 2024-03-05 21:59:37 -08:00
pnpm-lock.yaml pnpm update 2024-03-05 17:12:45 -06:00
quartz.config.ts revert: "fix(callout): reorder the plugins to render latex on callout… (#965) 2024-03-05 19:37:28 -08:00
quartz.layout.ts feat(experimental): partial rebuilds (jackyzha0#716) (#55) 2024-02-10 18:55:47 -08:00
README.md Update README.md 2024-03-06 15:45:17 -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 formatting, adjust toc 2024-02-07 08:54:06 -06:00

🌱 Forgetful Notes

code size repository size commits last commit is website up?

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.

Contents

Show/Hide

Screenshots

Show/Hide

Full Width

Website Screenshot

Slim (light)

Website Screenshot

Slim (dark)

Website Screenshot

Useful Commands

# Install Dependencies
npm install

# Update Dependencies
npm update

# Start Local Server
npm start

# Update Quartz
npm run update

# Sync the Repo
npm run sync

# Build Only
npm run build

# Find 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.