Adding A Tutorial on the Vuepress Documentation Website

[christyjacob4]

Feature request

What problem does this feature solve?

The existing documentation doesn't have a clear getting started guide. When I was getting started, I had to refer to videos to understand about the configuration and the hierarchy of the markdown files.

What does the proposed API look like?

I would like to add a tutorials section to the vuepress website.

How should this be implemented in your opinion?

I plan to add a section in the navigation bar called Tutorial that will provide a step by step guide to creating a multi page SPA using vuepress. It will help users understand about nesting in the sidebar etc.

Are you willing to work on this yourself?

Yes I would like to implement this feature

[jlooper]

hi, Christy, thanks for this. I'd be happy to work with you to implement this. If you'd like to PR your section I can help wordsmith it, excellent addition. Thank you!

[christyjacob4]

Hi Jen, I haven't started working on it though. I wanted to check if it was in the interest of the community and then start. I will make the changes and make a PR as soon as possible if that is fine?

[jlooper]

hi, do you want to put an outline here, or find a way to project manage it via 'projects', so as to put some structure around it? Any work in this direction is good for me.

[christyjacob4]

Hi, I'm open to suggestions in this regard and would like to proceed in the direction that is in the interest of everyone. Thanks.

[jlooper]

hi @christyjacob4 could you put an outline here, as a starter? thanks!

[christyjacob4]

Hi Jen, Are you asking me to outline the topics I'll cover in the tutorial in brief or in detail?
Thanks again!

[jlooper]

In detail if you can, thanks!

[christyjacob4]

Hi Jen, Sure I'll do as you mentioned. Please give me some time. Thanks!

[tomcam]

I'd be happy to write such a tutorial! Here's my suggestion.

• Vuepress default theme tutorial: creating your home page
• Create and link to more pages
• Handling graphic assets
• Formatting characters in Markdown
• Lines, lists, and blocks of text in Markdown
• Table syntax in Markdown
• Displaying code in Markdown
• Site configuration: config.js

EDIT: The most embarrassing typo ever

[tomcam]

I've put a first draft of the tutorial on GitHub.

[haoranpb]

Happy to work on the Chinese transition

[tomcam]

Thanks tons, ludanxer! I hope the powers that be approve it.

[tomcam]

@jlooper I did most of a soup-to-nuts tutorial and put it at https://github.com/tomcam/vuepress-tutorial-proposal. I've never done a PR before. Should I just do one? Not sure what the etiquette is.