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.

Sign up for GitHub

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

Jump to bottom

Add information to README.md about using NVM #10

Merged
merged 1 commit into from Jan 12, 2022
Merged

Add information to README.md about using NVM #10

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Expand Up @@ -154,6 +154,20 @@ Shiki::highlight(
);
```

## Using Node Version Manager

Under the hood, this package runs a node command to render the markdown. If you use NVM during development,
then the package will be unlikely to find your version of node as it looks for the node executable in
`/usr/local/bin` and `/opt/homebrew/bin` - if this is the case, then you should create a symlink between
the node distributable in your NVM folder, to that of the `usr/local/bin`. Such a command might look like this:

```bash
sudo ln -s /home/some-user/.nvm/versions/node/v17.3.1/bin/node /usr/local/bin/node
```

Creating this symlink will allow the package to find your NPM executable. Please note, if you change
your NPM version you will have to update your symlinks accordingly.

## Testing

You can run all the tests with this command:
Expand Down