3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-02 11:47:23 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/packages/create-docusaurus/templates/facebook
History
Joshua Chen 661bc32402
chore(deps): bump all dependencies; regenerate lockfile (#6580)
2022-02-02 13:00:31 +08:00
..
src feat: update website & init template palette to pass WCAG test; include contrast check in ColorGenerator (#5822) 2022-01-20 14:51:18 +08:00
static/img feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
.eslintrc.js chore: enable react/jsx-closing-bracket-location (#6373) 2022-01-16 12:41:17 +08:00
.prettierignore feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
.prettierrc chore: upgrade lint-staged and globs (#6369) 2022-01-15 16:33:09 +08:00
.stylelintrc.js 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
docusaurus.config.js fix(create-docusaurus): make initial editUrl functional (#6119) 2021-12-17 10:47:58 +08:00
gitignore feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
package.json chore(deps): bump all dependencies; regenerate lockfile (#6580) 2022-02-02 13:00:31 +08:00
README.md feat: allow GIT_USER env var to be unset if SSH is used (#5840) 2021-11-10 18:51:12 +08:00
sidebars.js feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02: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 opens 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

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.

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