Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Installation Guide doesn't specify local installation commands #957

Closed
rafaelmotaalves opened this issue Sep 12, 2018 · 2 comments
Closed

Comments

@rafaelmotaalves
Copy link

📚 Documentation

The Installation Guide, doesn't specify the commands to install Docusaurus locally in the created project, this makes it a little confusing.

Those commands would be:

npm install docusaurus-init --save

yarn add docusaurus-init

Should i make a PR to correct this?

@yangshun
Copy link
Contributor

When you do docusaurus-init, the generated files will include docusaurus in package.json. Only the person who initializes docusaurus will need to have docusaurus-init, to scaffold the project. From there on, other users just have to do npm/yarn start. Is there any confusion here?

Closing this issue as there doesn't seem to be anything wrong with the installation docs. feel free to reopen this if there's something I'm missing.

@rafaelmotaalves
Copy link
Author

Got it, i was under the impression you would install it as a development dependency.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants