quartz/README.md
2023-11-15 09:59:29 -06:00

46 lines
2.3 KiB
Markdown

<h1 align=center>🌱 Forgetful Notes</h1>
<p align="center">
<img alt="code size" src="https://img.shields.io/github/languages/code-size/semanticdata/forgetful-notes" />
<img alt="repository size" src="https://img.shields.io/github/repo-size/semanticdata/forgetful-notes" />
<img alt="commits" src="https://img.shields.io/github/commit-activity/t/semanticdata/forgetful-notes" />
<img alt="last commit" src="https://img.shields.io/github/last-commit/semanticdata/forgetful-notes" />
<img alt="is website up?" src="https://img.shields.io/website/https/forgetfulnotes.com.svg" />
</p>
## Introduction
This is the 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.
It is powered by [Quartz](https://github.com/jackyzha0/quartz/) and [Obsidian](https://obsidian.md). You can read the [Documentation](https://quartz.jzhao.xyz/), and join the [Discord Community](https://discord.gg/cRFFHYye7t).
## Screenshots
<img alt="Website Screenshot" src="screenshot.png" width="720px" />
## 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` |
| Sync Local Changes | `npx quartz sync` |
| Find Help | `npx quartz sync --help` |
## Style
### Fonts
| Used in: | Font Family |
| -------- | ------------------------------------------------------------------------ |
| Header | [Schibsted Grotesk](https://fonts.google.com/specimen/Schibsted+Grotesk) |
| Body | [Source Sans Pro](https://fonts.google.com/specimen/Source+Sans+3) |
| Code | [IBM Plex Mono](https://fonts.google.com/specimen/IBM+Plex+Mono) |
## License
Source code in this repository is available under the [MIT](LICENSE) license. You are free to use this code however you see fit. That said, some acknowledgement would be well received.