3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-02 03:37:48 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/examples/classic-typescript
History
Joshua Chen 73ee356949
docs: audit grammar issues (#6203) 
* docs: audit grammar mistakes

* fix code block language

* revert change

* let's get another
2021-12-27 19:34:04 +08:00
..
blog
docs docs: audit grammar issues (#6203) 2021-12-27 19:34:04 +08:00
src refactor: add blank lines below all copyright headers (#6071) 2021-12-09 11:53:46 +08:00
static
.gitignore
.stackblitzrc
babel.config.js
docusaurus.config.js chore(examples): update examples to 2.0.0-beta.14 (#6148) 2021-12-21 17:49:39 +01:00
package.json chore(examples): update examples to 2.0.0-beta.14 (#6148) 2021-12-21 17:49:39 +01:00
README.md chore(examples): update examples to 2.0.0-beta.14 (#6148) 2021-12-21 17:49:39 +01:00
sandbox.config.json
sidebars.js
tsconfig.json chore: fix gen script to support TS template (#5722) 2021-10-20 12:45:06 +02:00
yarn.lock chore(examples): update examples to 2.0.0-beta.14 (#6148) 2021-12-21 17:49:39 +01:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ 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.