Skip to content

Commit

Permalink
fix: 更新安装
Browse files Browse the repository at this point in the history
  • Loading branch information
shijinn520 committed Jul 8, 2024
1 parent 7a6dc58 commit 4326031
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 56 deletions.
61 changes: 6 additions & 55 deletions docs/start/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,12 @@

[git官网](https://git-scm.com/)

- `git`是一个分布式版本控制软件,`Karin`的所有文件默认均使用`git`进行管理、安装、更新。
- `git`是一个分布式版本控制软件,~~`Karin`的所有文件默认均使用`git`进行管理、安装、更新。 ~~
- `windows`用户如下载缓慢,可使用[腾讯软件管家][腾讯软件管家]进行加速下载。
- 还是一样,`git`也是一个可选项,所有插件包括`Karin`本身都可以直接下载压缩包进行安装。

- 目前`Karin`正在向纯`npm`包管理迁移,插件还在使用`git`,请继续安装。

## 部署karin

### 安装`pnpm`
Expand Down Expand Up @@ -84,65 +86,14 @@ npm config set registry https://registry.npmjs.org

:::

### 克隆项目
### 安装

::: warning 温馨提示
`KarinJS`组织的所有项目,均可通过将域名中的`github`更换为`gitee`进行加速下载~
:::

::: code-group

```bash [Github]
git clone --depth=1 https://github.com/KarinJS/Karin.git
```

```bash [Gitee]
git clone --depth=1 https://gitee.com/KarinJS/Karin.git
```

:::

### 安装依赖

::: warning 温馨提示
开发依赖较为臃肿庞大,普通用户请安装生产依赖即可
:::
先新建一个空白文件夹,以下命令在文件夹里面执行。

```bash
cd Karin
```

::: code-group

```bash [安装生产依赖]
pnpm install -P
```

```bash [安装开发依赖]
pnpm install
pnpm i node-karin && npx init && node .
```

:::

### 启动项目

::: warning 温馨提示
开发模式支持`plugins/apps`文件夹热更新、插件包的`index.js`热更新
正常启动下,仅支持热更新非插件包例如自带的`karin-plugin-example`
:::

::: code-group

```bash [正常启动]
node .
```

```bash [开发模式]
node . --dev
```

:::

## 安装渲染器

- [karin-puppeteer](./render.md)
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "karin",
"name": "karin-docs",
"author": "Lain",
"version": "0.0.3",
"devDependencies": {
Expand Down

0 comments on commit 4326031

Please sign in to comment.