Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support installing mmdc locally and skipping downloading Chromium #83

Merged
merged 2 commits into from
Jul 29, 2023

Conversation

alitrack
Copy link
Contributor

Skip Downloading Chromium

If you already have Chrome, Chromium, or MS Edge installed, you can skip downloading Chromium by setting the environment variable:

  • For Linux or macOS:
export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
  • For Windows:
set PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true

Adds Support for Installing mmdc (Mermaid CLI) Locally

To add support for installing mmdc (Mermaid CLI) locally on the user's machine.

Some people are having issues installing this tool globally. Installing it locally is an alternative solution:

npm install @mermaid-js/mermaid-cli

Configuration for MMDC in config.yml

Add the following configuration in your config.yml file to specify the locations of Puppeteer and MMDC:

PUPPETEER_CONFIG: "./puppeteer-config.json"
MMDC: "./node_modules/.bin/mmdc"

@voidking
Copy link
Collaborator

LGTM

@voidking
Copy link
Collaborator

Skip Downloading Chromium

If you already have Chrome, Chromium, or MS Edge installed, you can skip downloading Chromium by setting the environment variable:

  • For Linux or macOS:
export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
  • For Windows:
set PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true

Adds Support for Installing mmdc (Mermaid CLI) Locally

To add support for installing mmdc (Mermaid CLI) locally on the user's machine.

Some people are having issues installing this tool globally. Installing it locally is an alternative solution:

npm install @mermaid-js/mermaid-cli

Configuration for MMDC in config.yml

Add the following configuration in your config.yml file to specify the locations of Puppeteer and MMDC:

PUPPETEER_CONFIG: "./puppeteer-config.json"
MMDC: "./node_modules/.bin/mmdc"

The descriptions above should add to README.

@alitrack
Copy link
Contributor Author

@voidking done

@geekan
Copy link
Owner

geekan commented Jul 29, 2023

LGTM

@geekan geekan merged commit 6d8a1a1 into geekan:main Jul 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants