excalidraw/dev-docs
Aakansha Doshi ddb7585057
docs: Docs for v0.17.0 🚀 (#7248)
* feat: add docs for getCommonBounds

* docs: add docs for frames api support

* docs: update docs for regenerateIds opts in convertToExcalidrawElements

* add docs for ref removal

* add docs for lock support and insertOnCanvasDirectly in setActiveTool

* fix broken links

* update docs for next js support

* update docs for Preact

* add faq

* docs: add `onChange`, `onPointerDown`, `onPointerUp` docs

* docs: update `useDevice` docs

* update docs for disabling image tool

* add docs for withinBounds helpers

* fix lint

* upgrade excal

* add docusaurus2-dotenv for expose env vars

* fix env variable and upgrade excal

* Update dev-docs/docs/@excalidraw/excalidraw/api/excalidraw-element-skeleton.mdx

Co-authored-by: David Luzar <5153846+dwelle@users.noreply.github.com>

* update docs

Co-authored-by: David Luzar <5153846+dwelle@users.noreply.github.com>

* update docs for process.env

---------

Co-authored-by: dwelle <5153846+dwelle@users.noreply.github.com>
2023-11-14 19:54:34 +05:30
..
docs docs: Docs for v0.17.0 🚀 (#7248) 2023-11-14 19:54:34 +05:30
src docs: fix typo on homepage of developer docs (#7047) 2023-09-29 20:52:53 -05:00
static feat: update logo (#6979) 2023-09-11 17:47:41 +02:00
.gitignore 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
babel.config.js refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
docusaurus.config.js docs: Docs for v0.17.0 🚀 (#7248) 2023-11-14 19:54:34 +05:30
package.json docs: Docs for v0.17.0 🚀 (#7248) 2023-11-14 19:54:34 +05:30
sidebars.js docs: Docs for v0.17.0 🚀 (#7248) 2023-11-14 19:54:34 +05:30
tsconfig.json refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
yarn.lock docs: Docs for v0.17.0 🚀 (#7248) 2023-11-14 19:54:34 +05:30

README.md

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.