docs(v2): display yarn and npm command on website #2037
Conversation
| @@ -420,9 +420,6 @@ The following example is how you can have multi-language code tabs in your docs. | |||
|
|
|||
| And you will get the following: | |||
|
|
|||
| import Tabs from '@theme/Tabs'; | |||
There was a problem hiding this comment.
No need to redeclare because markdown above alrd has npm2yarn meta which will import the Tabs component for us
endiliey
added
pr: documentation
|
Deploy preview for docusaurus-2 ready! Built with commit ff834a5 |
|
Deploy preview for docusaurus-preview ready! Built with commit ff834a5 |
endiliey
added
the
status: don't merge yet
endiliey
removed
the
status: don't merge yet
| Docusaurus Themes' components are designed to be replaceable. To make it easier for you, we created a command for you to replace theme components called `swizzle`. | ||
|
|
||
| To swizzle a component for a theme, run the following command in your doc site: | ||
|
|
||
| ```shell | ||
| $ docusaurus swizzle [theme name] [component name] | ||
| docusaurus swizzle <theme name> [component name] |
There was a problem hiding this comment.
Side question - Does this actually work if they didn't install docusaurus globally? Or do they have to do npm run docusaurus swizzle ...?
There was a problem hiding this comment.
ah you are right. I only followed prevs docs
| node.children.forEach(transformer); | ||
| } | ||
| if (node.type === 'root' && transformed) { | ||
| node.children.unshift({ |
There was a problem hiding this comment.
If the MDX file already import @theme/Tabs this is gonna add an extra import statement right? But I guess it's fine, don't think repeated statements matter.
There was a problem hiding this comment.
yeah. the logic could have been better but this is easily avoidable with human error prevention.
Idw to make it too complex such that i have to check whole markdown if the import exist with babel parse. Its just increasing parsing time.
Hence why this will never be official
| npmCode | ||
| .replace(/^npm i$/gm, 'yarn') | ||
| // install: 'npm install --save foo' -> 'yarn add foo' | ||
| .replace(/npm install --save/gm, 'yarn add') |
There was a problem hiding this comment.
Wanna handle the npm install --save-dev scenario too? Although we won't likely need it.
There was a problem hiding this comment.
most likely we wont have dev i guess. Its hard to find perfect solution to convert npm 2 yarn
| // global install: 'npm i' -> 'yarn' | ||
| return ( | ||
| npmCode | ||
| .replace(/^npm i$/gm, 'yarn') |
There was a problem hiding this comment.
Why only this line has the ^?
There was a problem hiding this comment.
npm i => yarn
npm install —save => yarn add
Because if dont have ^ then it can be
yarnnstall —save 😂😂
If we replace the order then its fine but i did it so its explicit if its a “project reinstall”.
Thats why this is such a naive npm2yarn converter. Ive checked there is no such npm pkg to convert
There was a problem hiding this comment.
npm i => yarn
npm install —save => yarn add
Because if dont have ^ then it can be
yarnnstall —save 😂😂
If we replace the order then its fine but i did it so its explicit if its a “project reinstall”.
Thats why this is such a naive npm2yarn converter. Ive checked there is no such npm pkg to convert
| // install: 'npm install --save foo' -> 'yarn add foo' | ||
| .replace(/npm install --save/gm, 'yarn add') | ||
| // run command: 'npm run start' -> 'yarn run start' | ||
| .replace(/npm run/gm, 'yarn run') |
There was a problem hiding this comment.
If I'm not wrong yarn will try to run defined npm scripts if it's not a recognized yarn command. Maybe you can just replace with yarn instead of yarn run.
Motivation
Show npm and yarn command on website so our docs is more friendly to both package manager users.
I created a naive plugin to convert npm commands to yarn. Will never make it official because my solution to convert npm to yarn is naive. Making it official also means = more bug reports, i have to write tests, etc.
This is also not the best remark plugin in the world. Still fit our use case
Have you read the Contributing Guidelines on pull requests?
yes
Test Plan