3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-31 23:40:39 +02:00
Code Issues Projects Releases Packages Wiki Activity

Admin: How to publish to npm (#107)

Browse source 
This starts our admin section of docs, in .md format
This commit is contained in:
Joel Marcey 2017-10-03 15:24:38 -07:00 • committed by GitHub
parent 9c7d8e55a9
commit ce0e55ee9b
1 changed files with 32 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

32
admin/publish.md Normal file
View file

@ -0,0 +1,32 @@
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:
1. `npm adduser`
1. Enter username, password and associated email address
## Publish
1. Bump version number in `package.json`
2. `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/facebookexperimental/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`.