Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JustYuuto committed Dec 21, 2024
1 parent 677a4ac commit 660970f
Showing 1 changed file with 4 additions and 38 deletions.
42 changes: 4 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,7 @@
# Website
# Miwa.lol Documentation

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
Miwa.lol documentation for developers. This is a work in progress and may not be fully accurate.

### Installation
## Contributing

```
$ 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.
You can contribute to this documentation by making a fork of this repository and submitting a pull request.

0 comments on commit 660970f

Please sign in to comment.