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

Refine getting started documentation #2111

Closed
haoranpb opened this issue Jan 5, 2020 · 3 comments · Fixed by #2281
Closed

Refine getting started documentation #2111

haoranpb opened this issue Jan 5, 2020 · 3 comments · Fixed by #2281
Labels
contribution welcome Contributions welcome topic: docs Used when working with docs

Comments

@haoranpb
Copy link
Contributor

haoranpb commented Jan 5, 2020

Feature request

The Getting Started section does not contain the situation described in #2110 (Start from scratch, local install). And it doesn't mention nor provide a link about Using a plugin or Using a theme.

Another related issue is #1801 , a tutorial that guides users to start from nothing to a website that uses most of the VuePress features would be very helpful?

What problem does this feature solve?

Make the documentation more user-friendly for beginners.

What does the proposed API look like?

How should this be implemented in your opinion?

Rename Inside an Existing Project title, and add a section about starting from scratch with locally installed VuePress.

Are you willing to work on this yourself?

Yes

@billyyyyy3320 billyyyyy3320 added the topic: docs Used when working with docs label Jan 8, 2020
@kefranabg
Copy link
Collaborator

Thanks for the report @ludanxer. Feel free to open an PR if you're willing to on work on this 👍

@kefranabg kefranabg added the contribution welcome Contributions welcome label Jan 14, 2020
@haoranpb
Copy link
Contributor Author

Hi @kefranabg , Thanks for your reply! I have a question about the official way to quickly set up a VuePress site.

I know about the command yarn create vuepress, however, that package has not been updated for quite a while. Do you know if there is any plan to update it? Or a new CLI command vuepress new docs is expected?

@bencodezen
Copy link
Member

@ludanxer We definitely plan on providing an official CLI for scaffolding VuePress projects for sure. We know that this is a major pain point as a new user.

bencodezen pushed a commit that referenced this issue Jun 10, 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
larionov pushed a commit to larionov/vuepress that referenced this issue 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
contribution welcome Contributions welcome topic: docs Used when working with docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants