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.

Sign up for GitHub

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

Jump to bottom

Create a basic README for new Docusaurus project #925

Closed
endiliey opened this issue Aug 28, 2018 · 1 comment
Closed

Create a basic README for new Docusaurus project #925

endiliey opened this issue Aug 28, 2018 · 1 comment
Labels
difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR.

Comments

@endiliey
Copy link
Contributor

endiliey commented Aug 28, 2018 •
edited
Loading

🚀 Feature

When running docusaurus-init, we should at least create a basic README.md in website folder.

Have you read the Contributing Guidelines on issues?

Yes

Pitch

This will help anyone who contributes to a project using Docusaurus on how to quickly get started. The README created in website/README.md should contains something like this below. Be creative with the wordings 😃

🚀   Introduction

This website was created with Docusaurus.

📟   Install and Usage

First of all, you will need to install all the dependencies for the website

$ yarn

Now just run your dev server

$ yarn start

That's it! Now you can make changes to the docs folder of the project directory.

Check docusaurus.io to see more about Docusaurus!

Some examples:
-https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md
-https://github.com/facebook/react-native-website
-(insert any other good oss project)>
@endiliey endiliey added help wanted Asking for outside help and/or contributions to this particular issue or PR. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. labels Aug 28, 2018
@endiliey endiliey mentioned this issue Aug 28, 2018
Closed
@jaril
Copy link
Contributor

jaril commented Aug 28, 2018

I can take this on :)

@jaril jaril mentioned this issue Aug 30, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
difficulty: starter Issues that are starter difficulty level, e.g. minimal tweaking with a clear test plan. good first issue If you are just getting started with Docusaurus, this issue should be a good place to begin. help wanted Asking for outside help and/or contributions to this particular issue or PR.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jaril @endiliey