GitHub/quartz
1
0
Fork 2
mirror of https://github.com/jackyzha0/quartz.git synced 2026-03-24 23:15:46 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity
🌱 a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites
1,451 Commits 22 Branches 24 Tags 2.7 GiB
TypeScript 84.9%
SCSS 8.5%
JavaScript 4.8%
CSS 1.8%
6a52d43cb8
Go to file
Miguel Pimentel 6a52d43cb8
Update README.md
2024-05-11 11:00:03 -07:00
.github added commented defaults to reference while working on the layout 2024-04-22 13:58:10 -05:00
.vscode add extension settings 2024-03-25 17:41:37 -05:00
content formatting 2024-05-02 21:41:56 -05:00
docs Merge branch 'v4' of https://github.com/jackyzha0/quartz 2024-05-02 21:38:28 -05:00
quartz Merge branch 'v4' of https://github.com/jackyzha0/quartz 2024-04-19 11:24:27 -05:00
.gitattributes rgb to hex colors 2023-09-21 17:49:02 -05:00
.gitignore enable all plugins 2024-04-22 13:44:29 -05:00
.npmrc reorg layout 2024-03-14 14:28:49 -05:00
.prettierignore enable all plugins 2024-04-22 13:44:29 -05:00
.prettierrc pnpm run format 2024-03-14 12:28:44 -05:00
Dockerfile Create Dockerfile 2023-10-10 18:12:23 -05:00
globals.d.ts pnpm run format 2024-03-14 12:28:44 -05:00
index.d.ts pnpm run format 2024-03-14 12:28:44 -05:00
LICENSE minor changes/adjustments 2024-03-07 12:46:33 -06:00
package-lock.json Merge branch 'v4' of https://github.com/jackyzha0/quartz 2024-05-02 21:38:28 -05:00
package.json reorg dependencies 2024-05-02 21:39:40 -05:00
pnpm-lock.yaml pnpm update 2024-04-22 13:32:32 -05:00
quartz.config.ts formatting 2024-05-02 21:41:56 -05:00
quartz.layout.ts formatting 2024-05-02 21:41:56 -05:00
README.md Update README.md 2024-05-11 11:00:03 -07:00
tsconfig.json pnpm run format 2024-03-14 12:28:44 -05:00

README.md

🌱 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.