3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-04 12:47:14 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/examples/classic-typescript
History
Joshua Chen fd966b5395
refactor: add blank lines below all copyright headers (#6071)
2021-12-09 11:53:46 +08:00
..
blog
docs misc: replace all "Metadatas" with "Metadata" (#5871) 2021-11-09 19:46:10 +01: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
package.json chore: update examples for beta.8 (#5763) 2021-10-21 19:49:36 +02:00
README.md
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: update examples for beta.8 (#5763) 2021-10-21 19:49:36 +02: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

$ GIT_USER=<Your GitHub username> USE_SSH=true 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.