Skip to content

docs: improve installation guide for clarity #934

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

Closed
Omaima-Ameen wants to merge 1 commit into from
+9 −3
Closed

docs: improve installation guide for clarity #934

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,13 +89,19 @@ manually.
If you instead want to use JavaScript and JSX *inside* markdown files, use
[MDX][github-mdx].

## Install
## Installation

This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][npm-install]:
react-markdown is [ESM only][esm].
You must use Node.js 16+, modern bundlers (Vite / webpack 5+), or any runtime that supports ECMAScript modules. [npm][npm-install]:

*Node.js (npm, pnpm, yarn)*

```sh
npm install react-markdown
# or
pnpm add react-markdown
# or
yarn add react-markdown
```

In Deno with [`esm.sh`][esmsh]:
Expand Down
Loading