Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
shakuzen committed Sep 21, 2023
1 parent b23aa36 commit 5ecaa0f
Showing 1 changed file with 6 additions and 18 deletions.
24 changes: 6 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Website
# r/JapanFinance wiki

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
This is a mirror of the [r/JapanFinance](https://www.reddit.com/r/JapanFinance/) subreddit's wiki.

## Development

This website is built using [Docusaurus](https://docusaurus.io/), a static website generator.

### Installation

Expand All @@ -23,19 +27,3 @@ $ 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.

0 comments on commit 5ecaa0f

Please sign in to comment.