1
0
mirror of https://github.com/excalidraw/excalidraw.git synced 2024-11-10 11:35:52 +01:00
excalidraw/dev-docs
2022-07-26 16:55:25 +05:30
..
docs refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
src refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
static refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
.gitignore refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
babel.config.js refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
docusaurus.config.js refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
package.json refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
README.md refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
sidebars.js refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
tsconfig.json refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
yarn.lock refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30

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.