3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-04-29 02:08:36 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/packages/create-docusaurus/templates/shared
History
Sébastien Lorber 9ecff801ff
refactor: create @docusaurus/bundler and @docusaurus/babel packages (#10511)
2024-09-21 16:35:49 +02:00
..
blog fix(create-docusaurus): Improve init templates blog setup + fix warnings (#10392) 2024-08-12 15:59:03 +02:00
docs fix(create-docusaurus): fix typo in init template sample docs (#9783) 2024-01-24 11:57:55 +01:00
src feat(core): support TypeScript + ESM configuration (#9317) 2023-10-14 02:46:03 +02:00
static fix(create-docusaurus): improve init template misleading doc + add Docuaurus social card (#8279) 2022-11-02 17:03:00 +01:00
babel.config.js refactor: create @docusaurus/bundler and @docusaurus/babel packages (#10511) 2024-09-21 16:35:49 +02:00
gitignore feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
README.md fix(create-docusaurus): fix readme docusaurus 2 ref (#9487) 2023-10-31 23:15:16 +01:00

README.md

Website

This website is built using Docusaurus, 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.