mirror of
https://github.com/jackyzha0/quartz.git
synced 2026-03-24 23:15:46 -05:00
update README
This commit is contained in:
parent
756e90a5fc
commit
e8b076e7a1
22
README.md
22
README.md
@ -8,17 +8,19 @@
|
|||||||
|
|
||||||
# Forgetful Notes
|
# Forgetful Notes
|
||||||
|
|
||||||
This repo holds the source code for my digital garden.
|
Source code for Forgetful Notes—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.
|
||||||
|
|
||||||
- Based on [Quartz](https://github.com/jackyzha0/quartz/)
|
- Created with [Quartz](https://github.com/jackyzha0/quartz/)
|
||||||
- [Documentation](https://quartz.jzhao.xyz/)
|
- Read the [Documentation](https://quartz.jzhao.xyz/)
|
||||||
- [Join the Discord Community](https://discord.gg/cRFFHYye7t)
|
- Join the [Discord Community](https://discord.gg/cRFFHYye7t)
|
||||||
|
|
||||||
## Useful Commands
|
## Useful Commands
|
||||||
|
|
||||||
- `npm i`
|
| Command | Description |
|
||||||
- `npx quartz update`
|
| -------------------------- | -------------------------- |
|
||||||
- `npx quartz build --serve`
|
| `npm i` | Install Dependencies |
|
||||||
- `npx quartz sync`
|
| `npx quartz update` | Update Quartz (core) |
|
||||||
- `npx quartz build`
|
| `npx quartz build --serve` | Build and Serve Locally |
|
||||||
- `npx quartz sync --help`
|
| `npx quartz sync` | Save Local Changes to Repo |
|
||||||
|
| `npx quartz build` | Build without Serving |
|
||||||
|
| `npx quartz sync --help` | Find Help |
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user