From 0bdded3e8a0ca5c2ed5832ade83dc55cabfc682b Mon Sep 17 00:00:00 2001 From: Marukome0743 Date: Fri, 25 Apr 2025 11:09:12 +0900 Subject: [PATCH] docs: update Docusaurus README.md --- website/README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/website/README.md b/website/README.md index 6ffad61fe7c7c..b483040b518e8 100644 --- a/website/README.md +++ b/website/README.md @@ -1,16 +1,16 @@ # Website -This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. +This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. ### Installation -``` +```bash $ yarn ``` ### Local Development -``` +```bash $ yarn start ``` @@ -18,7 +18,7 @@ This command starts a local development server and opens up a browser window. Mo ### Build -``` +```bash $ yarn build ``` @@ -28,13 +28,13 @@ This command generates static content into the `build` directory and can be serv Using SSH: -``` +```bash $ USE_SSH=true yarn deploy ``` Not using SSH: -``` +```bash $ GIT_USER= yarn deploy ``` @@ -44,6 +44,6 @@ If you are using GitHub pages for hosting, this command is a convenient way to b Some common defaults for linting/formatting have been set for you. If you integrate your project with an open source Continuous Integration system (e.g. Travis CI, CircleCI), you may check for issues using the following command. -``` +```bash $ yarn ci ```