excalidraw/dev-docs
Aakansha Doshi d73cd14dfb
docs: add mermaid docs (#6971)
* docs: add mermaid docs

* fix link

* add development.mdx

* add codebase

* add parseEdge

* add subgraph

* convertors

* tweaks

* structure the codebase

* add docs for new diagram type

* decouple docs for flowchart parser

* fix broken links

* use diagram instead of chart

* revert package.json

* tweaks

* point root folder of mermaid-to-excalidraw to installation

* remove installation from sidebar children

* fix link

* update flowchart parser diagram

* update parser overview diagram

* update more diagrams

* remove note about change in element stroke

* update diagram

* increase size limit for excalidraw production bundle

* tweaks

* add link

* move codebase after introduction

* dummy

---------

Co-authored-by: dwelle <luzar.david@gmail.com>
2023-09-13 21:01:34 +05:30
..
docs docs: add mermaid docs (#6971) 2023-09-13 21:01:34 +05:30
src docs: add mermaid docs (#6971) 2023-09-13 21:01:34 +05:30
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
babel.config.js refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
docusaurus.config.js feat: update logo (#6979) 2023-09-11 17:47:41 +02:00
package.json build(deps): bump @excalidraw/excalidraw from 0.15.2 to 0.15.3 in /dev-docs (#6896) 2023-08-17 13:47:32 +02:00
README.md refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
sidebars.js docs: add mermaid docs (#6971) 2023-09-13 21:01:34 +05:30
tsconfig.json refactor: rename docs to dev-docs (#5487) 2022-07-26 16:55:25 +05:30
yarn.lock build(deps): bump @excalidraw/excalidraw from 0.15.2 to 0.15.3 in /dev-docs (#6896) 2023-08-17 13:47:32 +02:00

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.