mirror of https://github.com/facebook/docusaurus.git synced 2025-08-02 00:09:48 +02:00

History

Joshua Chen 4c246493ef refactor(init): share common files between templates (#5315 ) * Create shared folder & update init logic Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Restore needed links Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Prevent copying symlinks Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Reuse some FB files Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Minor tweak Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Minor refactors Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Fix bootstrap url Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Add path alias Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Handle facebook template more gracefully Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * minor refactor: extract getTypeScriptBaseTemplate Co-authored-by: slorber <lorber.sebastien@gmail.com>		2021-08-10 16:26:59 +02:00
..
src	refactor(init): share common files between templates (#5315 )	2021-08-10 16:26:59 +02:00
static/img	refactor(init): share common files between templates (#5315 )	2021-08-10 16:26:59 +02:00
.eslintrc.js	chore(v2): migrate babel-eslint to @babel/eslint-parser (#4453 )	2021-03-19 11:59:36 +01:00
.prettierignore
.prettierrc
.stylelintrc.js
babel.config.js
docusaurus.config.js	refactor(init): share common files between templates (#5315 )	2021-08-10 16:26:59 +02:00
gitignore
package.json	chore(v2): prepare v2.0.0-beta.4 release (#5238 )	2021-07-28 22:54:41 +02:00
README.md	docs(v2): fixed typos (#4560 )	2021-04-05 18:42:41 +02:00
sidebars.js	refactor(init): share common files between templates (#5315 )	2021-08-10 16:26:59 +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