Skip to content

README.md

Latest commit

 

History

History
111 lines (74 loc) · 4.81 KB

README.md

File metadata and controls

111 lines (74 loc) · 4.81 KB

🌱 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.
  • TypeScript: superset of JavaScript that compiles to clean JavaScript output.
  • Preact: fast 3kB alternative to React with the same modern API.
  • esbuild: an extremely fast JavaScript bundler and minifier.
  • D3.js: data-driven documents for interactive visualizations.
  • Shiki: a beautiful syntax highlighter.
  • KaTeX & MathJax: mathematical notation rendering.
  • FlexSearch: full-text search library.
  • Remark & Rehype: unified ecosystem for processing markdown and HTML.
  • Sass: makes CSS fun!
  • Prettier: an opinionated code formatter.

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.

🚀 Deployment

The site is automatically deployed to GitHub Pages when changes are pushed to the main branch. A backup deployment is also available on Vercel.

🤝 Contributing

This is a personal digital garden, but if you notice any issues or have suggestions:

  1. Check existing issues
  2. Open a new issue with detailed information
  3. For content suggestions, feel free to reach out via the website's contact methods

📝 Issues & Support

Found a bug or have a question?

For site-specific issues: Please open an issue with:

  • Clear description of the problem
  • Steps to reproduce (if applicable)
  • Your browser and OS information

For Quartz-related issues: If the issue is with Quartz itself (the static site generator), please report it in the Quartz repository instead.

© License

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