Skip to content

docs: add local environment instruction in Quick Start #2600

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

zungeru
Copy link

@zungeru zungeru commented Sep 6, 2020

Hello,

I added steps to run the "npm install" and "npm run dev" commands in the "Quick Start" section because it may not be immediately clear to folks how to start the development server.

Summary

What kind of change does this PR introduce? (check at least one)

  • Bugfix
  • Feature
  • Code style update
  • Refactor
  • Docs
  • Build-related changes
  • Other, please describe:

If changing the UI of default theme, please provide the before/after screenshot:

Does this PR introduce a breaking change? (check one)

  • Yes
  • No

If yes, please describe the impact and migration path for existing applications:

The PR fulfills these requirements:

  • When resolving a specific issue, it's referenced in the PR's title (e.g. fix #xxx[,#xxx], where "xxx" is the issue number)

You have tested in the following browsers: (Providing a detailed version will be better.)

  • Chrome
  • Firefox
  • Safari
  • Edge
  • IE

If adding a new feature, the PR's description includes:

  • A convincing reason for adding this feature
  • Related documents have been updated
  • Related tests have been updated

To avoid wasting your time, it's best to open a feature request issue first and wait for approval before working on it.

Other information:

Hello,

I added steps to run the "npm install" and "npm run dev" commands in the "Quick Start" section because it may not be immediately clear to folks how to start the development server.
Copy link
Collaborator

@billyyyyy3320 billyyyyy3320 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

With #2594, you can provide different code group for both npm and yarn

@billyyyyy3320 billyyyyy3320 changed the title Update getting-started.md docs: add local environment instruction in Quick Start Sep 13, 2020
@GregoireF
Copy link

Hi @zungeru,

Thank you for your interest in VuePress 1.X ❤️

I think this request can be closed due to an obvious evolution of VuePress 1.X

Here is an example in guide/getting-started :

  1. Serve the documentation site in the local server

    yarn docs:dev
    npm run docs:dev

    VuePress will start a hot-reloading development server at http://localhost:8080.

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

Successfully merging this pull request may close these issues.

3 participants