mirror of
https://github.com/jackyzha0/quartz.git
synced 2026-03-25 07:25:42 -05:00
74 lines
2.9 KiB
Markdown
74 lines
2.9 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>
|
|
|
|
## Overview
|
|
|
|
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).
|
|
|
|
## Table of Contents
|
|
|
|
<details>
|
|
<summary>Show/Hide</summary>
|
|
|
|
- [Overview](#overview)
|
|
- [Table of Contents](#table-of-contents)
|
|
- [Screenshots](#screenshots)
|
|
- [Full Width](#full-width)
|
|
- [Slim (light)](#slim-light)
|
|
- [Slim (dark)](#slim-dark)
|
|
- [Useful Commands](#useful-commands)
|
|
- [Style](#style)
|
|
- [Fonts](#fonts)
|
|
- [License](#license)
|
|
|
|
</details>
|
|
|
|
## Screenshots
|
|
|
|
### Full Width
|
|
|
|
<img alt="Website Screenshot" src="screenshot-full.png" width="720px" />
|
|
|
|
### Slim (light)
|
|
|
|
<img alt="Website Screenshot" src="screenshot-light.png" width="360px" />
|
|
|
|
### Slim (dark)
|
|
|
|
<img alt="Website Screenshot" src="screenshot-dark.png" width="360px" />
|
|
|
|
## 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 | Previous Font |
|
|
| -------- | :-----------------: | :---: |
|
|
| Headers | [Bitter](https://fonts.google.com/specimen/Bitter) | [Schibsted Grotesk](https://fonts.google.com/specimen/Schibsted+Grotesk) |
|
|
| Body | [Bitter](https://fonts.google.com/specimen/Bitter) | [Source Sans Pro](https://fonts.google.com/specimen/Source+Sans+3) |
|
|
| Code | [Fira Mono](https://fonts.google.com/specimen/Fira+Mono) | [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.
|