docusaurus/examples/classic-typescript
Sébastien Lorber 54986a3b21
chore: Update examples after release of Docusaurus v2.1.0 (#8041)
2022-09-02 13:05:04 +02:00
..
blog
docs chore: Update examples after release of Docusaurus v2.1.0 (#8041) 2022-09-02 13:05:04 +02:00
src
static
.gitignore
.stackblitzrc
README.md
babel.config.js
docusaurus.config.js
package.json chore: Update examples after release of Docusaurus v2.1.0 (#8041) 2022-09-02 13:05:04 +02:00
sandbox.config.json
sidebars.js chore: Update examples after release of Docusaurus v2.1.0 (#8041) 2022-09-02 13:05:04 +02:00
tsconfig.json

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.