1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-04-15 01:16:22 +02:00

Merge pull request #1221 from Unleash/docs/add-npm2yarn

docs: add `npm2yarn` annotation to all npm commands
This commit is contained in:
Thomas Heartman 2022-01-04 14:00:43 +01:00 committed by GitHub
commit be3452e36f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 10 additions and 8 deletions

View File

@ -73,7 +73,7 @@ docker run -p 4242:4242 \
1. Create a new folder/directory on your development computer.
2. From a terminal/bash shell, install the dependencies:
```sh
```shell npm2yarn
npm init
npm install unleash-server --save
```

View File

@ -94,7 +94,7 @@ Strategies are stored in separate JavaScript files and loaded into the container
1. **Create a strategies directory.** Create a directory that Docker has access to where you can store your strategies. The next steps assume you called it `strategies`
2. **Initialize a Node.js project** and **install the Unleash Client**:
``` shell
``` shell npm2yarn
npm init -y && \
npm install unleash-client
```
@ -137,7 +137,7 @@ The Unleash Proxy accepts a `customStrategies` property as part of its initializ
1. **Install the `unleash-client` package**. You'll need this to implement the custom strategy:
``` shell
``` shell npm2yarn
npm install unleash-client
```

View File

@ -11,7 +11,7 @@ In this guide we explain how to use feature toggles in a Node application using
First we must install Node.js dependency:
```sh
```shell npm2yarn
npm install unleash-client
```

View File

@ -15,7 +15,7 @@ For single-page apps we have a tiny proxy-client in JavaScript, without any exte
**Step 1: Install**
```
```shell npm2yarn
npm install unleash-proxy-client
```

View File

@ -10,10 +10,8 @@ For more detailed information, check out [the React Proxy SDK on GitHub](https:/
## Installation
```sh
```shell npm2yarn
npm install @unleash/proxy-client-react
// or
yarn add @unleash/proxy-client-react
```
## Initialize the client

View File

@ -110,6 +110,9 @@ module.exports = {
editUrl:
'https://github.com/Unleash/unleash/edit/master/website/',
routeBasePath: '/',
remarkPlugins: [
[require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}]
]
},
theme: {
customCss: require.resolve('./src/css/custom.css'),

View File

@ -17,6 +17,7 @@
"@docusaurus/core": "2.0.0-beta.9",
"@docusaurus/plugin-client-redirects": "2.0.0-beta.9",
"@docusaurus/preset-classic": "2.0.0-beta.9",
"@docusaurus/remark-plugin-npm2yarn": "^2.0.0-beta.14",
"@mdx-js/react": "1.6.22",
"@svgr/webpack": "6.1.2",
"clsx": "1.1.1",