mirror of
https://github.com/jackyzha0/quartz.git
synced 2026-03-24 15:05:42 -05:00
167 lines
4.6 KiB
Markdown
167 lines
4.6 KiB
Markdown
# 🌱 Forgetful Notes
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[Forgetful Notes](https://forgetfulnotes.com) 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.
|
|
|
|
[](https://forgetfulnotes.com/)
|
|
[](https://forgetful-notes.vercel.app/)
|
|
|
|
## ✨ 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
|
|
|
|
```sh
|
|
git clone https://github.com/semanticdata/forgetful-notes.git
|
|
```
|
|
|
|
### 2. Install dependencies
|
|
|
|
```sh
|
|
pnpm install
|
|
```
|
|
|
|
### 3. Run the project locally
|
|
|
|
```sh
|
|
pnpm start
|
|
```
|
|
|
|
## 👨🏼💻 Useful Commands
|
|
|
|
### Update Quartz
|
|
|
|
```sh
|
|
npm run update
|
|
```
|
|
|
|
### Sync changes
|
|
|
|
```sh
|
|
npm run sync
|
|
```
|
|
|
|
### Read about a command
|
|
|
|
```sh
|
|
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](https://fonts.google.com/specimen/Bitter) | [Schibsted Grotesk](https://fonts.google.com/specimen/Schibsted+Grotesk) |
|
|
| Body | [Poppins](https://fonts.google.com/specimen/Poppins) | [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) |
|
|
|
|
## 🛠️ Technology
|
|
|
|
The site uses various technologies cobbled together. Here's a few of them:
|
|
|
|
- [Quartz](https://github.com/jackyzha0/quartz): a fast, batteries-included static-site generator.
|
|
- [Prettier](https://github.com/prettier/prettier): an opinionated code formatter.
|
|
- [Sass](https://github.com/sass/sass): makes CSS fun!
|
|
- [TypeScript](https://github.com/microsoft/TypeScript): superset of JavaScript that compiles to clean JavaScript output.
|
|
|
|
All content for the site is written in _Markdown_ within [Obsidian](https://obsidian.md/)—an extensible, flexible note-taking app. To export the notes from Obsidian, I rely on the [GitHub Publisher](https://github.com/ObsidianPublisher) plugin.
|
|
|
|
## 🔀 Workflows
|
|
|
|
### 🔨 Build only
|
|
|
|
|
|
```yml
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0 # Fetch all history for git info
|
|
- uses: actions/setup-node@v4
|
|
with:
|
|
node-version: 18
|
|
- name: Install Dependencies
|
|
run: npm i
|
|
- name: Build Quartz
|
|
run: npx quartz build
|
|
```
|
|
|
|
### 🚀 Build and Deploy
|
|
|
|
```yml
|
|
# Using npm
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0 # Fetch all history for git info
|
|
- name: Setup Node
|
|
uses: actions/setup-node@v4
|
|
with:
|
|
node-version: 18
|
|
- name: Install Dependencies
|
|
run: npm i
|
|
- name: Build Quartz
|
|
run: npm run build
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: public
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v4
|
|
```
|
|
|
|
```yml
|
|
# Using pnpm
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
with:
|
|
fetch-depth: 0 # Fetch all history for git info
|
|
- name: Setup PNPM
|
|
uses: pnpm/action-setup@v3
|
|
with:
|
|
version: 8
|
|
- name: Get pnpm store directory
|
|
shell: bash
|
|
run: |
|
|
echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
|
|
- name: Setup pnpm cache
|
|
uses: actions/cache@v4
|
|
with:
|
|
path: ${{ env.STORE_PATH }}
|
|
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-pnpm-store-
|
|
- name: Install dependencies
|
|
run: pnpm install
|
|
- name: Build Quartz Site
|
|
run: pnpm run build
|
|
- name: Upload artifact
|
|
uses: actions/upload-pages-artifact@v3
|
|
with:
|
|
path: public
|
|
- name: Deploy to GitHub Pages
|
|
uses: actions/deploy-pages@v4
|
|
id: deployment
|
|
```
|
|
|
|
## © License
|
|
|
|
Source code in this repository is available under the [MIT License](LICENSE).
|