mirror of https://github.com/facebook/docusaurus.git synced 2025-05-01 03:08:17 +02:00

History

Swalah Amani c541e2d83c misc: replace all "Metadatas" with "Metadata" (#5871 ) Co-authored-by: Josh-Cena <sidachen2003@gmail.com>		2021-11-09 19:46:10 +01:00
..
blog	feat: npm init docusaurus, yarn create docusaurus (#5635 )	2021-10-07 16:06:42 +02:00
docs	misc: replace all "Metadatas" with "Metadata" (#5871 )	2021-11-09 19:46:10 +01:00
src/pages	feat: npm init docusaurus, yarn create docusaurus (#5635 )	2021-10-07 16:06:42 +02:00
static	feat: npm init docusaurus, yarn create docusaurus (#5635 )	2021-10-07 16:06:42 +02:00
babel.config.js	feat: npm init docusaurus, yarn create docusaurus (#5635 )	2021-10-07 16:06:42 +02:00
gitignore	feat: npm init docusaurus, yarn create docusaurus (#5635 )	2021-10-07 16:06:42 +02:00
README.md	feat: npm init docusaurus, yarn create docusaurus (#5635 )	2021-10-07 16:06:42 +02:00
sidebars.js	refactor(content-docs): refactor sidebars, Joi validation, generator rework, expose config types (#5678 )	2021-10-14 14:38:26 +02:00

Website

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

$ yarn

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

$ yarn build

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

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