3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-22 13:37:05 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/packages/create-docusaurus/templates/shared
History
Arien Shibani 53fa0ecb1f
fix(create-docusaurus): Improve init template README, fix headings and remove $ in bash code blocks (#11157)
2025-05-08 18:10:21 +02:00
..
blog misc(blog): Update Yangshun bio (#10942) 2025-02-21 12:16:03 +01: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
gitignore feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
README.md fix(create-docusaurus): Improve init template README, fix headings and remove $ in bash code blocks (#11157) 2025-05-08 18:10:21 +02: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.