1
0
mirror of https://github.com/excalidraw/excalidraw.git synced 2024-11-10 11:35:52 +01:00
excalidraw/dev-docs
Jezreel Maldonado ded0222e8d
docs: add note for tests that have requisites (#6856)
Co-authored-by: David Luzar <luzar.david@gmail.com>
2023-08-05 09:51:50 +00:00
..
docs docs: add note for tests that have requisites (#6856) 2023-08-05 09:51:50 +00:00
src docs: update docs for next version (#6251) 2023-04-18 21:03:17 +05:30
static docs: migrating dev docs to docusaurus :) (#6073) 2023-02-01 19:57:54 +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 docs: enable Algolia for search (#6230) 2023-02-13 17:39:11 +05:30
package.json chore: upgrade excalidraw version to 0.15.2 (#6496) 2023-04-20 17:40:08 +05:30
README.md refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
sidebars.js docs: migrating dev docs to docusaurus :) (#6073) 2023-02-01 19:57:54 +05:30
tsconfig.json refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
yarn.lock build(deps): bump semver from 5.7.1 to 5.7.2 in /dev-docs (#6757) 2023-08-01 16:14:08 +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.