3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-24 20:17:50 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/examples/classic
History
Sébastien Lorber 5543f09ed1
chore: json files should be linted (#4462)
2021-03-18 19:39:50 +01:00
..
blog feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
docs chore(v2): upgrade example projects (#4399) 2021-03-11 17:01:04 +01:00
src chore(v2): upgrade example projects (#4399) 2021-03-11 17:01:04 +01:00
static feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
.gitignore feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
babel.config.js feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
docusaurus.config.js feat(v2): improve templates, use JSDoc type annotation, improve docusaurus.config.js autocompletion (#4098) 2021-01-27 15:34:12 +01:00
package.json chore: json files should be linted (#4462) 2021-03-18 19:39:50 +01:00
README.md feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
sandbox.config.json chore: json files should be linted (#4462) 2021-03-18 19:39:50 +01:00
sidebars.js feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
yarn.lock chore(v2): upgrade example projects (#4399) 2021-03-11 17:01:04 +01:00

README.md

Website

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

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open 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.