Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.07 KB

README.md

File metadata and controls

53 lines (33 loc) · 1.07 KB

docusaurus i18n template

docusaurus project with i18n

Website

This website is built using Docusaurus, 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.

For development with i18n in Docusaurus, you need to specify the locale when starting the development server. The default yarn start only serves the default locale.

$ yarn start --locale fr

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Always do a full build and test with yarn serve before deployment

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.