3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-24 03:58:49 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/packages/create-docusaurus/templates/facebook
History
Sébastien Lorber f6ec757aa0
feat: npm init docusaurus, yarn create docusaurus (#5635) 
* initial create-docusaurus impl

* cleanup

* @docusaurus/init renamed to create-docusaurus

* 0.0.6

* update lockfile

* fix lint

* remove npm2yarn for "npm init" because npm2yarn doesn't convert it and yarn result fails to execute

* prettier

* add correct version

* prettier

* prettier

* prettier

* prettier

* fix annoying --config .prettierrc issue
2021-10-07 16:06:42 +02:00
..
src feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
static/img feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
.eslintrc.js feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
.prettierignore feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
.prettierrc feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02: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 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
package.json 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 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

$ 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