/forgetful-notes

🌱 Forgetful Notes is 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.

Primary LanguageTypeScriptMIT LicenseMIT

🌱 Forgetful Notes

code size repository size commits last commit is website up?

Forgetful Notes is 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.

Github Pages Vercel

✨ Features

  • Fast Natural-Language Search
  • Bidirectional Backlinks
  • Floating Link Previews
  • Admonition-style Callouts
  • Markdown Links and Wikilinks Support
  • Latex Support

⚡ Quick start

1. Clone repo

git clone https://github.com/semanticdata/forgetful-notes.git

2. Install dependencies

pnpm install

3. Run the project locally

pnpm start

👨🏼‍💻 Useful Commands

Update Quartz

npm run update

Sync changes

npm run sync

Read about a command

npx quartz <command> --help

🎨 Customization

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.

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

🛠️ Technology

The site uses various technologies cobbled together. Here's a few of them:

  • Quartz: a fast, batteries-included static-site generator.
  • Prettier: an opinionated code formatter.
  • Sass: makes CSS fun!
  • TypeScript: superset of JavaScript that compiles to clean JavaScript output.

All content for the site is written in Markdown within Obsidian—an extensible, flexible note-taking app. To export the notes from Obsidian, I rely on the GitHub Publisher plugin.

© License

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