quartz/README.md
2023-09-30 08:24:29 -05:00

69 lines
2.2 KiB
Markdown

<p align="right">
<img src="https://img.shields.io/github/languages/code-size/semanticdata/forgetful-notes" />
<img src="https://img.shields.io/github/repo-size/semanticdata/forgetful-notes" />
<img src="https://img.shields.io/github/commit-activity/t/semanticdata/forgetful-notes" />
<img src="https://img.shields.io/github/last-commit/semanticdata/forgetful-notes" />
<img src="https://img.shields.io/website/https/forgetfulnotes.com.svg" />
</p>
# Forgetful Notes
Source code for [Forgetful Notes](https://forgetfulnotes.com)—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.
- Powered by [Quartz](https://github.com/jackyzha0/quartz/) and [Obsidian](https://obsidian.md).
- Read the [Documentation](https://quartz.jzhao.xyz/).
- Join the [Discord Community](https://discord.gg/cRFFHYye7t).
## Useful Commands
| Description | Command |
| -------------------------- | -------------------------- |
| Install Dependencies | `npm i` |
| Update Dependencies | `npm update` |
| Update Quartz (core) | `npx quartz update` |
| Build only | `npx quartz build` |
| Build and Serve | `npx quartz build --serve` |
| Save Local Changes to Repo | `npx quartz sync` |
| Find Help | `npx quartz sync --help` |
## Style
### Fonts
| Use | Font |
| ------ | ----------------- |
| Header | Schibsted Grotesk |
| Body | Source Sans Pro |
| Code | IBM Plex Mono |
### Light Mode
| Variable | Color |
| --------- | ---------- |
| Light | \#faf8f8 |
| Lightgray | \#e5e5e5 |
| Gray | \#b8b8b8 |
| Darkgray | \#4e4e4e |
| Dark | \#2b2b2b |
| Secondary | \#284b63 |
| Terciary | \#84a59d |
| Highlight | \#8f9fa926 |
### Dark Mode
| Variable | Color |
| --------- | ---------- |
| Light | \#1e1e2e |
| Lightgray | \#6c7086 |
| Gray | \#a6adc8 |
| Darkgray | \#cdd6f4 |
| Dark | \#cdd6f4 |
| Secondary | \#a6e3a1 |
| Terciary | \#89dceb |
| Highlight | \#8f9fa926 |
## License
Source code is available under [MIT](LICENSE).