From ee90cf4a766ec4497e3c78e4f4195f5e6cfad139 Mon Sep 17 00:00:00 2001 From: Clement Yan Date: Fri, 27 Oct 2023 01:01:45 +0800 Subject: [PATCH] chore(docs): Update README --- packages/docusaurus/README.md | 22 ++-------------------- 1 file changed, 2 insertions(+), 20 deletions(-) diff --git a/packages/docusaurus/README.md b/packages/docusaurus/README.md index aaba2fa1e16e..461c04efdc9c 100644 --- a/packages/docusaurus/README.md +++ b/packages/docusaurus/README.md @@ -2,13 +2,7 @@ This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. -### Installation - -``` -$ yarn -``` - -### Local Development +### Development ``` $ yarn start @@ -26,16 +20,4 @@ This command generates static content into the `build` directory and can be serv ### Deployment -Using SSH: - -``` -$ USE_SSH=true yarn deploy -``` - -Not using SSH: - -``` -$ GIT_USER= 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. +The `master` branch is automatically deployed to https://yarnpkg.com/ via [Netlify](https://www.netlify.com/). Pull Requests are also deployed as Deploy Previews.