docusaurus/website
Ivan Boothe effa46e930
docs: update GitHub deployment instructions (#5888)
* SSH is required for GitHub deployment now

Matches what is listed in the default README.md of a new Docusaurus site

* Minimum node version required is 14.x

documentation.yml as written fails to run because the minimum node version for Docusaurus is 14.x

* Add link to default URL of locally-served site

* Correct deployment workflow

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
2021-11-07 13:29:56 +08:00
..
_dogfooding chore(website): enable eslint in website (#5889) 2021-11-06 19:04:45 +08:00
blog
community
docs docs: update GitHub deployment instructions (#5888) 2021-11-07 13:29:56 +08:00
src docs: Add juffalow.com to Docusaurus showcase (#5895) 2021-11-07 10:35:05 +08:00
static
versioned_docs docs: '5 minutes tutorial' -> '5-minute tutorial' (#5876) 2021-11-05 10:58:57 +08:00
versioned_sidebars chore: prepare v2.0.0-beta.9 release (#5859) 2021-11-02 20:40:01 +03:00
README.md
babel.config.js chore(website): enable eslint in website (#5889) 2021-11-06 19:04:45 +08:00
delayCrowdin.js
docusaurus.config-blog-only.js
docusaurus.config.js chore(website): enable eslint in website (#5889) 2021-11-06 19:04:45 +08:00
netlify.toml
package.json chore(website): enable eslint in website (#5889) 2021-11-06 19:04:45 +08:00
sidebars.js chore(website): enable eslint in website (#5889) 2021-11-06 19:04:45 +08:00
sidebarsCommunity.js chore(website): enable eslint in website (#5889) 2021-11-06 19:04:45 +08:00
tsconfig.json
versions.json chore: prepare v2.0.0-beta.9 release (#5859) 2021-11-02 20:40:01 +03:00
versionsArchived.json chore: prepare v2.0.0-beta.9 release (#5859) 2021-11-02 20:40:01 +03:00
waitForCrowdin.js chore(website): enable eslint in website (#5889) 2021-11-06 19:04:45 +08:00

README.md

Docusaurus 2 Website

Installation

  1. yarn install in the root of the repo (one level above this directory).
  2. In this directory, do yarn start.
  3. A browser window will open up, pointing to the docs.