mirror of
https://github.com/facebook/docusaurus.git
synced 2025-04-29 10:17:55 +02:00
1.4 KiB
1.4 KiB
Docusaurus is published as an npm package that can be installed via npm
or yarn
. Here is how you publish the package to npm:
Log in to npm
Publishing will only work if you are logged into npm with an account with admin rights to the package.
If you are not currently logged into npm locally:
npm adduser
- Enter username, password and associated email address
Publish
- Bump version number in
package.json
. - Update the changelog.
- Run
npm install
andyarn install
to updatepackage-lock.json
and/oryarn.lock
. - From the
website
directory, runnpm run version x.x.x
, where x.x.x is the same version number you updated to inpackage.json
. - Run
npm publish
What version should you use?
The version number should generally increase by some factor than the current one. You can check current version by looking in package.json
.
{
"name": "docusaurus",
"version": "1.0.0-alpha.41",
"repository": {
"type": "git",
"url": "https://github.com/facebook/Docusaurus.git"
}
...
}
For the above example, you may want to bump the version to 1.0.0-alpha.42
or 1.0.0-beta.1
or 1.0.1
.
You can also see the full list of all published versions with npm show docusaurus versions --json
.