Skip to content

Commit

Permalink
docs: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tasshi-me committed Jun 15, 2024
1 parent e2dcd8e commit 8497151
Showing 1 changed file with 3 additions and 37 deletions.
40 changes: 3 additions & 37 deletions website/README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,7 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
The source of [https://cli.kintone.dev/](https://cli.kintone.dev/).

### Installation
## Development

```
$ yarn
```

### Local Development

```
$ yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

### Build

```
$ yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

Using SSH:

```
$ USE_SSH=true yarn deploy
```

Not using SSH:

```
$ GIT_USER=<Your GitHub username> yarn deploy
```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
See [Contributing](https://cli.kintone.dev/community/contributing) page.

0 comments on commit 8497151

Please sign in to comment.