docusaurus/examples/classic
Paul O’Shannessy 8341527fc9
refactor: rename Git master branch to main (#5345)
* Prepare to renaming master branch to main

* Update CONTRIBUTING.md

* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/missing_version_website/website/package.json

* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/complex_website/website/package.json

* Update packages/docusaurus-migrate/src/__tests__/__fixtures__/simple_website/website/package.json

* missing master -> main replaces

* useless char

* For GH Pages org deploy, DEPLOYMENT_BRANCH env is now required

* fix versioning page

* fix vercel links

* update deployment.mdx

Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: slorber <lorber.sebastien@gmail.com>
2021-08-17 18:41:53 +02:00
..
blog chore(v2): upgrade examples to beta.2 (#5057) 2021-06-24 20:02:57 +02:00
docs chore(v2): upgrade examples to beta.2 (#5057) 2021-06-24 20:02:57 +02:00
src chore(v2): upgrade examples to beta.2 (#5057) 2021-06-24 20:02:57 +02:00
static chore(v2): update examples to use alpha73 (#4631) 2021-04-16 14:08:23 +02:00
.gitignore feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
.stackblitzrc feat: docusaurus.new + improved StackBlitz playground (#5235) 2021-07-28 19:27:58 +02:00
babel.config.js feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
docusaurus.config.js refactor: rename Git master branch to main (#5345) 2021-08-17 18:41:53 +02:00
package.json feat: docusaurus.new + improved StackBlitz playground (#5235) 2021-07-28 19:27:58 +02:00
README.md chore(v2): update examples to use alpha73 (#4631) 2021-04-16 14:08:23 +02:00
sandbox.config.json fix(v2): examples should use Node 14 by default on CodeSandbox + regen with alpha72 (#4574) 2021-04-07 18:28:06 +02:00
sidebars.js chore(v2): update examples to use alpha73 (#4631) 2021-04-16 14:08:23 +02:00
yarn.lock feat: docusaurus.new + improved StackBlitz playground (#5235) 2021-07-28 19:27:58 +02:00

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