Skip to content

Commit 8437ab1

Browse files
committed
Updated readme
1 parent 7dd7740 commit 8437ab1

File tree

1 file changed

+49
-12
lines changed

1 file changed

+49
-12
lines changed

README.md

Lines changed: 49 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,60 @@
1-
# Nextra Docs Template
1+
# Waifu.it Documentation
22

3-
This is a template for creating documentation with [Nextra](https://nextra.site).
3+
## Getting Started
44

5-
[**Live Demo →**](https://nextra-docs-template.vercel.app)
5+
Install dependencies,
66

7-
[![](.github/screenshot.png)](https://nextra-docs-template.vercel.app)
7+
```bash
8+
$ npm i
9+
```
810

9-
## Quick Start
11+
Start the dev server,
1012

11-
Click the button to clone this repository and deploy it on Vercel:
13+
```bash
14+
$ npm run dev
15+
```
1216

13-
[![](https://vercel.com/button)](https://vercel.com/new/clone?s=https%3A%2F%2Fgithub.com%2Fshuding%2Fnextra-docs-template&showOptionalTeamCreation=false)
17+
Build documentation,
1418

15-
## Local Development
19+
```bash
20+
$ npm run build
21+
```
1622

17-
First, run `pnpm i` to install the dependencies.
23+
# Contributing
1824

19-
Then, run `pnpm dev` to start the development server and visit localhost:3000.
25+
All contributions are greatly appreciated, but I recommend creating an issue or replying in a comment to let me know what you are working on first that way we don't overwrite each other.
2026

21-
## License
27+
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on this project.
28+
29+
## Issues
30+
31+
- Feature requests/enhancements
32+
- Bug reports
33+
- Questions/feedback
34+
35+
## Branches
36+
37+
- production -> don't touch, this is what's running in production
38+
39+
- staging -> [pull request][pr] this branch for everything
40+
41+
## Pull Requests
42+
43+
All pull requests are welcome!
44+
45+
- [Fork][fork] the repository on GitHub.
46+
47+
- [Clone][cloning] the forked repo to your local machine.
48+
49+
- Do you changes
50+
51+
- Commit your changes
52+
53+
- Push your changes back up to your fork.
54+
55+
- When you're ready, submit a [pull request][pr] so that we can review your changes.
56+
57+
[fork]: https://help.github.com/en/articles/fork-a-repo
58+
[cloning]: https://help.github.com/en/articles/cloning-a-repository
59+
[pr]: https://help.github.com/en/articles/about-pull-requests
2260

23-
This project is licensed under the MIT License.

0 commit comments

Comments
 (0)