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

docs: refine getting started (close #2111) #2281

Merged
merged 6 commits into from
Jun 10, 2020
Merged

docs: refine getting started (close #2111) #2281

merged 6 commits into from
Jun 10, 2020

Conversation

haoranpb
Copy link
Contributor

@haoranpb haoranpb commented Apr 5, 2020

Summary

Hi guys, I wrote a draft to close #2111 , what do you think?

I took the liberty of not recommend globally install VuePress, hope it's expected

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:

@meteorlxy
Copy link
Member

Looks good. What about finishing the zh translation

@meteorlxy
Copy link
Member

BTW, I think 2-spaces indent is better

@haoranpb
Copy link
Contributor Author

haoranpb commented Apr 6, 2020

Thanks for taking a look! @meteorlxy

Finished Chinese translation.

Just tried 2-spaces indent, but it can't pass lint

Don’t use mixed indentation for children, add 1 space list-item-content-indent remark-lint

@meteorlxy
Copy link
Member

(alright, not familiar with remark-lint)

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.

LGTM

@billyyyyy3320
Copy link
Collaborator

cc @bencodezen

@bencodezen
Copy link
Member

Looks great to me. Thanks @ludanxer for your PR!

@bencodezen bencodezen merged commit 20e7329 into vuejs:master Jun 10, 2020
larionov pushed a commit to larionov/vuepress that referenced this pull request Aug 19, 2020
* docs: getting started steps

* docs: dir structure and basic config

* docs: ready for review

* docs: tweaks

* docs: fix list-item-content-indent

* docs: zh translation
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.

Refine getting started documentation
4 participants