mirror of https://github.com/facebook/docusaurus.git synced 2025-08-03 16:59:06 +02:00

History

LittleboyHarry 22e231904d feat(v2): improve templates, use JSDoc type annotation, improve `docusaurus.config.js` autocompletion (#4098 ) Co-authored-by: LittleboyHarry <LittleboyHarry@users.noreply.github.com>		2021-01-27 15:34:12 +01:00
..
blog	feat(v2): blog slug frontmatter (#3284 )	2020-08-20 14:59:54 +02:00
docs	docs(v2): i18n doc + polish (#4014 )	2021-01-19 17:26:31 +01:00
src	docs(v2): i18n doc + polish (#4014 )	2021-01-19 17:26:31 +01:00
static	feat(v2): add nojekyll file to static folder for all templates (#2902 )	2020-06-08 09:45:57 +08:00
babel.config.js	feat(v2): Allow configuring babel via babel.config.js (#2903 )	2020-06-12 11:03:00 +08: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
gitignore	misc(v2): nitpicky formatting	2019-12-04 00:55:52 -08:00
package.json	docs(v2): i18n doc + polish (#4014 )	2021-01-19 17:26:31 +01:00
README.md	fix(v2): Fix markdownlint rules on template init/README #3465	2020-09-29 12:23:06 +02:00
sidebars.js	çhore(v2): revert changes	2020-05-13 13:32:04 -03:00

Website

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

Installation

yarn install

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.

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.