docusaurus/packages/docusaurus-init/templates/classic
Alexey Pyltsyn d8ebe8b2e4 v2.0.0-alpha.56 2020-05-27 20:18:28 +03:00
..
blog
docs misc: minor improvements for init templates (#2802) 2020-05-24 19:47:04 +08:00
src chore(v2): mention about docs home page in init templates (#2763) 2020-05-18 13:14:06 +08:00
static/img misc: use branded favicon in init templates (#2803) 2020-05-24 12:48:04 +08:00
README.md
docusaurus.config.js chore(v2): mention about docs home page in init templates (#2763) 2020-05-18 13:14:06 +08:00
gitignore
package.json v2.0.0-alpha.56 2020-05-27 20:18:28 +03:00
sidebars.js çhore(v2): revert changes 2020-05-13 13:32:04 -03: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 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.