add package run scripts

This commit is contained in:
semanticdata 2024-01-30 13:33:05 -06:00
parent 0f0653ef24
commit 6e13d50d48
2 changed files with 54 additions and 1 deletions

View File

@ -26,6 +26,12 @@ It is powered by [Quartz](https://github.com/jackyzha0/quartz/) and [Obsidian](h
- [Slim (light)](#slim-light)
- [Slim (dark)](#slim-dark)
- [Useful Commands](#useful-commands)
- [Install Dependencies](#install-dependencies)
- [Start Local Server](#start-local-server)
- [Update Quartz](#update-quartz)
- [Sync the Repo](#sync-the-repo)
- [Build Only](#build-only)
- [Find Help](#find-help)
- [Style](#style)
- [Fonts](#fonts)
- [License](#license)
@ -58,6 +64,49 @@ It is powered by [Quartz](https://github.com/jackyzha0/quartz/) and [Obsidian](h
| Sync Local Changes | `npx quartz sync` |
| Find Help | `npx quartz sync --help` |
### Install Dependencies
```bash
npm i
npm install
```
### Start Local Server
```bash
npm start
npm run start
npx quartz build --serve
```
### Update Quartz
```bash
npm run update
npx quartz update
```
### Sync the Repo
```bash
npm run sync
npx quartz sync
```
### Build Only
```bash
npm run build
npx quartz build
```
### Find Help
```bash
npx quartz --help
npx quartz <command> --help
```
## Style
### Fonts

View File

@ -16,7 +16,11 @@
"check": "tsc --noEmit && npx prettier . --check",
"format": "npx prettier . --write",
"test": "tsx ./quartz/util/path.test.ts",
"profile": "0x -D prof ./quartz/bootstrap-cli.mjs build --concurrency=1"
"profile": "0x -D prof ./quartz/bootstrap-cli.mjs build --concurrency=1",
"update": "npx quartz update",
"sync": "npx quartz sync",
"start": "npx quartz build --serve",
"build": "npx quartz build"
},
"engines": {
"npm": ">=9.3.1",