mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-05 20:32:42 +02:00
78349480af
* prepare v1-v2 domain switch * rename v1 changelog as CHANGELOG-1.x.md * switch v1/v2 changelogs * Cleanup v2.docusaurus.io urls * add netlify domain redirect * remove circleci config * remove another circle file
65 lines
1.4 KiB
Markdown
65 lines
1.4 KiB
Markdown
# Remark plugin npm2yarn
|
|
|
|
## Motivation:
|
|
|
|
Transforms npm bash command code blocks to Docusaurus tabs:
|
|
|
|
The following (remove the `//`):
|
|
|
|
````bash
|
|
// ```bash npm2yarn
|
|
// npm run build
|
|
// ```
|
|
````
|
|
|
|
Becomes:
|
|
|
|
|
|
|
|
**Note**: it only works when used with Docusaurus themes that have the `Tabs` and `TabItems` components.
|
|
|
|
## Install
|
|
|
|
```bash
|
|
npm install @docusaurus/remark-plugin-npm2yarn
|
|
```
|
|
|
|
It is a Remark plugin, **not a Docusaurus plugin**, so you have to install it as a Remark plugin in the config of your Docusaurus plugins.
|
|
|
|
```js
|
|
module.exports = {
|
|
presets: [
|
|
[
|
|
'@docusaurus/preset-classic',
|
|
{
|
|
docs: {
|
|
// ...
|
|
remarkPlugins: [
|
|
[require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}],
|
|
],
|
|
},
|
|
blog: {
|
|
// ...
|
|
remarkPlugins: [
|
|
[require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}],
|
|
],
|
|
},
|
|
pages: {
|
|
// ...
|
|
remarkPlugins: [
|
|
[require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}],
|
|
],
|
|
},
|
|
// ...
|
|
},
|
|
],
|
|
],
|
|
// ...
|
|
};
|
|
```
|
|
|
|
## Options
|
|
|
|
| Property | Type | Default | Description |
|
|
| --- | --- | --- | --- |
|
|
| `sync` | `boolean` | `false` | Syncing tab choices (yarn and npm). See https://docusaurus.io/docs/markdown-features/#syncing-tab-choices for details. |
|