3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-02 19:57:25 +02:00
Code Issues Projects Releases Packages Wiki Activity
Easy to maintain open source documentation websites.
7 commits 47 branches 176 tags 876 MiB
TypeScript 87.3%
HTML 7%
JavaScript 2.7%
CSS 2%
XSLT 0.8%
Find a file
LittleboyHarry 70a775f954 feat(v2): improve templates, use JSDoc type annotation, improve docusaurus.config.js autocompletion (#4098) 
Co-authored-by: LittleboyHarry <LittleboyHarry@users.noreply.github.com>
2021-01-27 15:34:12 +01:00
blog feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
docs feat(v2): core v2 i18n support + Docusaurus site Crowdin integration (#3325) 2020-11-26 12:16:46 +01:00
src polish(v2): improve codesandbox template package.json (#4074) 2021-01-20 13:29:45 +01:00
static feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
.gitignore feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
babel.config.js feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
docusaurus.config.js feat(v2): improve templates, use JSDoc type annotation, improve docusaurus.config.js autocompletion (#4098) 2021-01-27 15:34:12 +01:00
package.json polish(v2): improve codesandbox template package.json (#4074) 2021-01-20 13:29:45 +01:00
README.md feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
sandbox.config.json polish(v2): improve codesandbox template package.json (#4074) 2021-01-20 13:29:45 +01:00
sidebars.js feat(v2): official CodeSandbox support (#3717) 2020-11-16 16:20:16 +01:00
yarn.lock polish(v2): improve codesandbox template package.json (#4074) 2021-01-20 13:29:45 +01:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and open 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.