Virtual whiteboard for sketching hand-drawn like diagrams
Go to file
Aakansha Doshi f23cdc47ee
docs: migrating dev docs to docusaurus :) (#6073)
* docs: migrating existing docs to docosaraus :)

* log broken links

* lint :p

* fix

* divide the doc into diff categories

* fix

* order sidebars and more

* fix lint

* point to installation

* making docs better :)

* fix

* renaming git

* renaming git

* fix links

* fix

* update readme

* fix

* resolve duplicate url and make /docs as base url

* fix

* move main docs as well

* making docs better

* support mdx

* update og

* fix title

* upgrade docusarus to stable version

* use draculla theme

* fix

* make entire sidebar collapsable

* live editor for footer wohoo

* render excalidraw only on client to fix the prod build

* migrate MainMenu to live editor too :)

* lint :p

* cleanup integration and use live editor and tabs

* fix

* Add welcome screen doc

* Live Collaboration comp docs

* Add collaborator example

* Add example

* add more

* remove isCollaborating

* Rewrite ref and move to sidebar

* change color of links inside pre

* add initial data

* fix lint

* Add styling

* fix lint

* Add example for customizing styles

* fix lint

* fix

* fix lint

* Add link to livecollabtrigger

* fix

* rewrite UIOptions to sidebar

* move initialdata to sidebar

* move render props to sidebar and rewrite renderTopRightUI and renderCustomStats

* rewrite renderSidebar

* update og

* update url for testing

* fix url

* update readme

* fix style

* tweaks

* Add highlight comp to highlight text

* Add bash syntax highlight

* fix

* tweaks

* fix

* rewrite export utilities

* fix restore

* rewrite utils

* move constants to sidebar

* update readme

* add copyright

* fix links style

* Add linkedin

* tweaks

* rename package to @excalidraw/excalidraw

* enable algolia with dummy creds

* tweaks to integration doc

* tweak WelcomeScreen docs to reflect upcoming API changes

* tweak components intro

* tweak nomenclature

* fix admonition

* rename `components` sidebar item and change order of components list

* uncollapse package section in sidebar

* show level 4 haeadings in TOC

* remove algolia

* remove unused assets

* capitalize C

* tweak

* rename components to App

* rename components -> children-components in the routes

* move notable used tools to intro

* update MainMenu docs with `onSelect` preventDefault behavior

* change sidebar label for children components

* use code

* tweak README & docs intro

* tweak package development doc

* make scrollbar gutter stable

* tweak api intro

* add admonition for export utils

* use next

* wip

* wip

* make excalidraw examples use current color theme & prefer system

* fix welcomescreen docs

* use latest temp release

* fix component order

* revert wip changes

* use next

* tweak

* increase height to fix welcome screen hint

* tweak editor height

* update excal version

* wrap Excal with forwardRef to fix refs

* migrate contributing.md

* fix broken links

---------

Co-authored-by: dwelle <luzar.david@gmail.com>
2023-02-01 19:57:54 +05:30
.codesandbox chore: update CodeSandbox links and add a config (#5624) 2022-08-29 18:52:04 +05:30
.github build: move release scripts to use release branch (#5958) 2022-12-06 16:33:02 +05:30
.husky build: temporarily disable pre-commit (#6132) 2023-01-19 13:50:42 +01:00
dev-docs docs: migrating dev docs to docusaurus :) (#6073) 2023-02-01 19:57:54 +05:30
firebase-project fix: update `storage.rules` (#5020) 2022-04-17 22:47:00 +02:00
public fix: declare css variable for font in excalidraw so its available in host (#6160) 2023-01-25 15:44:20 +05:30
scripts fix: PWA not working after CRA@5 update (#6012) 2022-12-18 22:23:30 +01:00
src docs: migrating dev docs to docusaurus :) (#6073) 2023-02-01 19:57:54 +05:30
.dockerignore build: stops ignoring .env files from docker context so env variables get set during react app build. (#5809) 2022-11-07 16:48:38 +05:30
.editorconfig add editorconfig (#1198) 2020-04-03 19:19:01 +02:00
.env.development fix: disable FAST_REFRESH to fix live reload (#5852) 2022-11-09 17:13:20 +05:30
.env.production feat: go-to-excalidrawplus button (#5202) 2022-05-18 18:30:34 +02:00
.eslintignore feat: image support (#4011) 2021-10-21 22:05:48 +02:00
.eslintrc.json chore: Update Typescript to 4.4.4 (#4188) 2021-11-02 14:24:16 +02:00
.gitattributes Add gitattributes (#2164) 2020-09-15 21:59:00 +02:00
.gitignore fix: set the dimensions of bound text correctly (#5710) 2022-09-22 15:40:38 +05:30
.lintstagedrc.js Keep errors, elements and comments consistent (#2340) 2020-11-05 18:06:18 +01:00
.npmrc Add npmrc to have pinned deps (#727) 2020-02-07 13:59:23 +01:00
.nvmrc Chore: Update .nvmrc to match package.json engines definition (#3148) 2021-03-01 13:22:20 +01:00
.prettierignore Change target branch of coverage and pretty print (#1850) 2020-07-01 12:05:21 +03:00
.watchmanconfig Don't reset cache while zooming using a gesture (#1103) 2020-03-28 16:59:36 -07:00
CHANGELOG.md support embedding scene data to PNG/SVG (#2219) 2020-10-13 14:47:07 +02:00
CONTRIBUTING.md docs: migrating dev docs to docusaurus :) (#6073) 2023-02-01 19:57:54 +05:30
Dockerfile chore: Bump nginx version to newest (#3811) 2021-07-09 17:07:34 +02:00
LICENSE Add MIT License (#176) 2020-01-05 13:09:29 -08:00
README.md docs: migrating dev docs to docusaurus :) (#6073) 2023-02-01 19:57:54 +05:30
crowdin.yml Locale 2020-03-19 20:38:52 +02:00
docker-compose.yml chore: Update action versions and docker build (#3065) 2021-02-20 14:28:33 +00:00
package.json fix: make tunnels work in multi-instance scenarios (#6178) 2023-02-01 10:46:17 +05:30
tsconfig-types.json chore: bump typescript@4.5.2 (#4283) 2021-11-19 19:51:28 +01:00
tsconfig.json chore: bump typescript@4.5.2 (#4283) 2021-11-19 19:51:28 +01:00
vercel.json feat: redirect vscode.excalidraw.com to vscode marketplace (#5285) 2022-06-23 17:42:50 +02:00
yarn.lock fix: make tunnels work in multi-instance scenarios (#6178) 2023-02-01 10:46:17 +05:30

README.md

Excalidraw logo: Sketch handrawn like diagrams.

Virtual whiteboard for sketching hand-drawn like diagrams.
Collaborative and end-to-end encrypted.

Follow Excalidraw on Twitter Chat with us on Discord

Try now

Visit excalidraw.com to start sketching.

Community

For latest updates, follow us on twitter. If you need help or want to chat, join us on Discord. For releases and deep dives, check out our blog. Report bugs on GitHub.

Supporting Excalidraw

If you like the project, you can become a sponsor at Open Collective.

Last but not least, we're thankful to these companies for offering their services for free:

Vercel Sentry Crowdin

Developers

You can integrate Excalidraw into your app by installing our npm component.

Visit our documentation on https://docs.excalidraw.com.

Who's integrating Excalidraw

Google CloudMetaCodeSandboxObsidian ExcalidrawReplitSliteNotionHackerRank