mirror of https://github.com/facebook/docusaurus.git synced 2025-07-19 01:28:38 +02:00

History

Sébastien Lorber 986de6b214 chore(v2): prepare v2.0.0.alpha-71 release (#4376 ) * prepare release * v2.0.0-alpha.71		2021-03-09 18:45:05 +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	docs(v2): update FB OSS logo (#3881 )	2020-12-28 11:38:07 +01:00
.eslintrc.js	chore(v2): fix eslint TS setup (#2949 )	2020-06-18 17:37:48 +08:00
.prettierignore
.prettierrc	chore(v2): update Prettier config (#2542 )	2020-04-05 23:51:47 +08:00
.stylelintrc.js
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
package.json	chore(v2): prepare v2.0.0.alpha-71 release (#4376 )	2021-03-09 18:45:05 +01:00
README.md
sidebars.js

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.

Continuous Integration

Some common defaults for linting/formatting have been set for you. If you integrate your project with an open source Continuous Integration system (e.g. Travis CI, CircleCI), you may check for issues using the following command.

$ yarn ci