mirror of
https://github.com/excalidraw/excalidraw.git
synced 2026-11-20 21:23:22 +03:00
* docs(repo): redirect docs.excalidraw.com to plus.excalidraw.com/docs/sdk The developer docs moved to the Excalidraw+ docs. Every old page redirects to its new location, and anything else redirects to the docs home. * docs(repo): redirect the mermaid-to-excalidraw docs to their own section The package's docs moved to plus.excalidraw.com/docs/mermaid-to-excalidraw, rewritten for v3.
44 lines
997 B
Markdown
44 lines
997 B
Markdown
# Website
|
|
|
|
> **The developer docs have moved to [plus.excalidraw.com/docs/sdk](https://plus.excalidraw.com/docs/sdk).** `vercel.json` redirects every docs.excalidraw.com page to its new location, so changes here are no longer published.
|
|
|
|
This website is built using [Docusaurus 2](https://docusaurus.io/), 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.
|