3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-09 07:07:25 +02:00
Code Issues Projects Releases Packages Wiki Activity
docusaurus/packages/create-docusaurus/templates/shared
History
Sébastien Lorber c84d779627
chore: backport retro compatible commits for the Docusaurus v2.3 release (#8585) 
Co-authored-by: stnor <stefan@selessia.com>
Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Co-authored-by: sebastienlorber <lorber.sebastien@gmail.com>
Co-authored-by: Sébastien Lorber <slorber@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Matija Sirk <matija.sirk@kopit.si>
Co-authored-by: AHMET BAYHAN BAYRAMOGLU <49499275+ABB65@users.noreply.github.com>
Co-authored-by: Stefan Norberg <stefan@norberg.org>
Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com>
Co-authored-by: Muhammad Hammad <33136628+mhnaeem@users.noreply.github.com>
Co-authored-by: Denis Al-Khelali <denis.al-khelali@itechart-group.com>
Co-authored-by: Balthasar Hofer <lebalz@outlook.com>
Co-authored-by: Danny Kim <0916dhkim@gmail.com>
Co-authored-by: Frieder Bluemle <frieder.bluemle@gmail.com>
Co-authored-by: John Reilly <johnny_reilly@hotmail.com>
Co-authored-by: Robert Lawrence <62929526+r-lawrence@users.noreply.github.com>
Co-authored-by: Sadegh Karimi <sadegh.krmi@gmail.com>
Co-authored-by: Lachlan Heywood <lachieh@users.noreply.github.com>
Co-authored-by: mturoci <64769322+mturoci@users.noreply.github.com>
Co-authored-by: 宋锦丰 <36468758+SJFCS@users.noreply.github.com>
Co-authored-by: Nguyễn Thành Nam <namnguyenthanh.work@gmail.com>
Co-authored-by: Dongjoon Lee <djunnni@gmail.com>
Co-authored-by: Thomas.CA <44041651+Thomascogez@users.noreply.github.com>
Co-authored-by: Riccardo <riccardo.odone@gmail.com>
Co-authored-by: Lane Goolsby <lanegoolsby@yahoo.com>
Co-authored-by: Mariusz Krzaczkowski <m.krzaczkowski@yetiforce.com>
Co-authored-by: Matija Sirk <sirkmatija@gmail.com>
Co-authored-by: Jiří <zmrhal.j@gmail.com>
2023-01-27 17:02:15 +01:00
..
blog feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
docs chore: backport retro compatible commits for the Docusaurus v2.3 release (#8585) 2023-01-27 17:02:15 +01:00
src/pages feat: npm init docusaurus, yarn create docusaurus (#5635) 2021-10-07 16:06:42 +02:00
static chore: backport retro compatible commits for the Docusaurus v2.3 release (#8585) 2023-01-27 17:02:15 +01:00
babel.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
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 chore: backport retro compatible commits for the Docusaurus v2.1 release (#8033) 2022-09-02 12:20:33 +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.