|
1 |
| -# Nextra Docs Template |
| 1 | +# Waifu.it Documentation |
2 | 2 |
|
3 |
| -This is a template for creating documentation with [Nextra](https://nextra.site). |
| 3 | +## Getting Started |
4 | 4 |
|
5 |
| -[**Live Demo →**](https://nextra-docs-template.vercel.app) |
| 5 | +Install dependencies, |
6 | 6 |
|
7 |
| -[](https://nextra-docs-template.vercel.app) |
| 7 | +```bash |
| 8 | +$ npm i |
| 9 | +``` |
8 | 10 |
|
9 |
| -## Quick Start |
| 11 | +Start the dev server, |
10 | 12 |
|
11 |
| -Click the button to clone this repository and deploy it on Vercel: |
| 13 | +```bash |
| 14 | +$ npm run dev |
| 15 | +``` |
12 | 16 |
|
13 |
| -[](https://vercel.com/new/clone?s=https%3A%2F%2Fgithub.com%2Fshuding%2Fnextra-docs-template&showOptionalTeamCreation=false) |
| 17 | +Build documentation, |
14 | 18 |
|
15 |
| -## Local Development |
| 19 | +```bash |
| 20 | +$ npm run build |
| 21 | +``` |
16 | 22 |
|
17 |
| -First, run `pnpm i` to install the dependencies. |
| 23 | +# Contributing |
18 | 24 |
|
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. |
20 | 26 |
|
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 |
22 | 60 |
|
23 |
| -This project is licensed under the MIT License. |
|
0 commit comments