Skip to content

Commit

Permalink
chore: 修改项目说明
Browse files Browse the repository at this point in the history
  • Loading branch information
terwer committed Mar 19, 2023
1 parent 59f6589 commit c45182e
Showing 1 changed file with 8 additions and 16 deletions.
24 changes: 8 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,34 @@

a blog based on siyuan-note api

## 规范
## 快速上手

- `ts` 规则请在 `.prettierrc.json` 添加,`eslint` 会自动继承此规则并生效

## Setup

Make sure to install the dependencies:
### docker-compose

```bash
# Make sure you have `shamefully-hoist=true` in `.npmrc` before running pnpm install
pnpm install
docker compose up --build
```

## Development Server
### 本地启动

Start the development server on http://localhost:3000

```bash
# Make sure you have `shamefully-hoist=true` in `.npmrc` before running pnpm install
pnpm install
pnpm dev
```

## Production
### 生产环境

Build the application for production:

```bash
pnpm build
```

Locally preview production build:

```bash
pnpm preview
```

Staticly generate a site:
Statically generate a site:

```bash
pnpm generate
Expand Down

0 comments on commit c45182e

Please sign in to comment.