mirror of
https://github.com/mermaid-js/mermaid.git
synced 2026-05-23 20:10:38 +00:00
Added new line to
[1mMERMAID LOCAL DOCKER DEVELOPMENT[0m Welcome! Thank you for joining the development. This is a script for running commands within docker containers at ease. __________________________________________________________________________________________ Development Quick Start Guide: [1m./run pnpm install[0m # Install packages [1m./run dev[0m # Launch dev server with examples, open http://localhost:9000 [1m./run docs:dev[0m # Launch official website, open http://localhost:3333 [1m./run pnpm vitest[0m # Run watcher for unit tests [1m./run cypress[0m # Run integration tests (after starting dev server) [1m./run pnpm build[0m # Prepare it for production __________________________________________________________________________________________ Commands: [1m./run build[0m # Build image [1m./run cypress[0m # Run integration tests [1m./run dev[0m # Run dev server with examples, open http://localhost:9000 [1m./run docs:dev[0m # For docs contributions, open http://localhost:3333 [1m./run help[0m # Show this help [1m./run pnpm[0m # Run any 'pnpm' command [1m./run sh[0m # Open 'sh' inside docker container for development __________________________________________________________________________________________ Examples of frequently used commands: [1m./run pnpm add --filter mermaid[0m [4mpackage[0m Add package to mermaid [1m./run pnpm -w run lint:fix[0m Run prettier and ES lint [1mgit diff --name-only develop | xargs ./run pnpm prettier --write[0m Prettify everything you added so far [1m./run cypress open --project .[0m Open cypress interactive GUI [1m./run cypress run --spec cypress/integration/rendering/[0m[4mtest.spec.ts[0m Run specific test in cypress [1mxhost +local:[0m Allow local connections for x11 server or [1mMERMAID LOCAL DOCKER DEVELOPMENT[0m Welcome! Thank you for joining the development. This is a script for running commands within docker containers at ease. __________________________________________________________________________________________ Development Quick Start Guide: [1m./run pnpm install[0m # Install packages [1m./run dev[0m # Launch dev server with examples, open http://localhost:9000 [1m./run docs:dev[0m # Launch official website, open http://localhost:3333 [1m./run pnpm vitest[0m # Run watcher for unit tests [1m./run cypress[0m # Run integration tests (after starting dev server) [1m./run pnpm build[0m # Prepare it for production __________________________________________________________________________________________ Commands: [1m./run build[0m # Build image [1m./run cypress[0m # Run integration tests [1m./run dev[0m # Run dev server with examples, open http://localhost:9000 [1m./run docs:dev[0m # For docs contributions, open http://localhost:3333 [1m./run help[0m # Show this help [1m./run pnpm[0m # Run any 'pnpm' command [1m./run sh[0m # Open 'sh' inside docker container for development __________________________________________________________________________________________ Examples of frequently used commands: [1m./run pnpm add --filter mermaid[0m [4mpackage[0m Add package to mermaid [1m./run pnpm -w run lint:fix[0m Run prettier and ES lint [1mgit diff --name-only develop | xargs ./run pnpm prettier --write[0m Prettify everything you added so far [1m./run cypress open --project .[0m Open cypress interactive GUI [1m./run cypress run --spec cypress/integration/rendering/[0m[4mtest.spec.ts[0m Run specific test in cypress [1mxhost +local:[0m Allow local connections for x11 server output
This commit is contained in:
Mason Deacon