-
Notifications
You must be signed in to change notification settings - Fork 22
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c1cf5b3
commit 967caf5
Showing
1 changed file
with
122 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,125 @@ | ||
# thewiki | ||
Retype docs for thewiki.moe | ||
<br/> | ||
<p align="center"> | ||
<a href="https://github.com/Snaacky/thewiki"> | ||
<img src="https://github.com/Snaacky/thewiki/assets/78981416/efdae8dc-2f53-45cd-8a75-6036b81eeafa" alt="Logo" width="200" height="200"> | ||
</a> | ||
|
||
## How to edit | ||
<h3 align="center">thewiki.moe</h3> | ||
|
||
1. [Create a new branch to do your work on](https://user-images.githubusercontent.com/4893775/213875083-5042d163-a775-49cd-88a1-090a65670b0c.png) | ||
2. [Do your work on it and commit the changes](https://user-images.githubusercontent.com/4893775/213875253-3578bbb1-cbe2-4250-9cd9-5c5412245d27.png) | ||
3. [Create a new pull request](https://user-images.githubusercontent.com/4893775/213874701-b4bcb7b9-bc3d-4c9f-a7d2-81b45b1009d6.png) | ||
4. [Squash and merge it](https://user-images.githubusercontent.com/4893775/213874863-624e7f47-ec39-4e6a-97ed-6b90fb8e5f4e.png) | ||
<p align="center"> | ||
Retype docs for thewiki.moe, a wiki for all things related to anime and more. | ||
<br/> | ||
<br/> | ||
<a href="https://thewiki.moe/"><strong>Explore the wiki »</strong></a> | ||
<br/> | ||
<br/> | ||
</p> | ||
</p> | ||
|
||
## Useful links | ||
* [Retype formatting guide](https://retype.com/guides/formatting/) | ||
* [Retype components list](https://retype.com/components/) | ||
* [Retype page configuration options](https://retype.com/configuration/page/) | ||
* [Retype folder configuration options](https://retype.com/configuration/folder/) | ||
<div align="center"> | ||
|
||
[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/Snaacky/thewiki/retype-action.yml?style=flat&logo=github)](https://github.com/Snaacky/thewiki/actions) [![GitHub issues](https://img.shields.io/github/issues/Snaacky/thewiki?style=flat&logo=github)](https://github.com/Snaacky/thewiki/issues) [![License](https://img.shields.io/github/license/Snaacky/thewiki?style=flat&logo=unlicense)](https://github.com/Snaacky/thewiki/blob/master/LICENSE) [![Discord](https://img.shields.io/discord/974468300304171038?style=flat&logo=discord)](https://discord.gg/snackbox) | ||
</div> | ||
|
||
## Table Of Contents | ||
|
||
* [Built With](#built-with) | ||
* [Getting Started](#getting-started) | ||
* [Prerequisites](#prerequisites) | ||
* [Installation](#installation) | ||
* [Contributing](#contributing) | ||
* [License](#license) | ||
* [Contributors](#contributors) | ||
|
||
## Built With | ||
|
||
[![Retype](https://retype.com/static/retype-logo-dark.svg)](https://retype.com/) | ||
|
||
## Getting Started | ||
|
||
To get a local copy up and running follow these simple steps. | ||
|
||
### Prerequisites | ||
|
||
1. [Node.js](https://nodejs.org/en). You can install this with [`nvm`](https://github.com/nvm-sh/nvm) or [`nvm-windows`](https://github.com/coreybutler/nvm-windows) depending on your OS | ||
|
||
2. After installing `nvm` run | ||
|
||
```sh | ||
nvm install latest | ||
``` | ||
|
||
```sh | ||
nvm use latest | ||
``` | ||
|
||
### Installation | ||
|
||
1. Install [retypeapp](https://www.npmjs.com/package/retypeapp). You can install it using npm or yarn | ||
|
||
```sh | ||
npm install retypeapp --global | ||
``` | ||
|
||
```sh | ||
yarn global add retypeapp | ||
``` | ||
|
||
2. Clone the repo | ||
|
||
```sh | ||
git clone https://github.com/Snaacky/thewiki.git | ||
``` | ||
|
||
4. Build and run | ||
|
||
The `retype start` command automatically opens the default web browser on your machine and loads the website into the browser | ||
|
||
```sh | ||
retype start thewiki | ||
``` | ||
|
||
Alternatively, you can use `retype build` to build it without running it | ||
|
||
```sh | ||
retype build thewiki --output retype | ||
``` | ||
|
||
## Contributing | ||
|
||
Any contributions you make are **greatly appreciated**. | ||
|
||
- If you have any suggestions, feel free to [open an issue](https://github.com/Snaacky/thewiki/issues/new) to discuss it, join our [discord](https://discord.gg/snackbox), or directly create a pull request. | ||
- Please make sure you check your spelling and grammar. | ||
- Create individual PR for each suggestion. | ||
|
||
|
||
### Creating A Pull Request | ||
|
||
1. Fork this repository | ||
2. Create your feature branch | ||
|
||
```sh | ||
git checkout -b feature/NewGuide | ||
``` | ||
3. Commit your changes | ||
|
||
```sh | ||
git commit -m 'Add some NewGuide' | ||
``` | ||
4. Push to the branch | ||
|
||
```sh | ||
git push origin feature/NewGuide | ||
``` | ||
5. Open a pull request | ||
|
||
## License | ||
|
||
Distributed under the [Unlicense](https://opensource.org/license/unlicense/) License. See [LICENSE](https://github.com/Snaacky/thewiki/blob/master/LICENSE) for more information. | ||
|
||
## Contributors | ||
|
||
<a href="https://github.com/Snaacky/thewiki/graphs/contributors"> | ||
<img src="https://contrib.rocks/image?repo=Snaacky/thewiki" /> | ||
</a> |