sommio/thewiki

Retype docs for thewiki.moe

thewiki.moe

Retype docs for thewiki.moe, a wiki for all things related to anime and more.
Explore the wiki »

Table Of Contents

• Getting Started
  • Prerequisites
  • Installation
• Contributing
• License
• Contributors

Getting Started

thewiki is built using Retype. See how you can host a local copy on your machine:

Prerequisites

• Node.js - This can be installed with nvm or nvm-windows depending on your OS

• To install with nvm, run the following in your terminal:

  nvm install latest

  nvm use latest

Installation

1. Install retypeapp. You can install it using npm or yarn:

   npm install retypeapp --global

   yarn global add retypeapp

2. Clone this repo:

   git clone https://github.com/Snaacky/thewiki.git

   cd thewiki

3. Build and run:

   • The retype start command automatically prepares and loads the website into the browser:

     retype start

   • Alternatively, you can use retype build to build it without running it:

     retype build --output retype

Contributing

Contributions are much appreciated!

• If you have any suggestions, feel free to open an issue to discuss it, join our Discord, or create a pull request
• Make sure you check your spelling and grammar
• Create an individual PR for each suggestion

Creating A Pull Request

1. Fork this repository

2. Create your feature branch

   git checkout -b feature/NewGuide

3. Commit your changes

   git commit -m 'Add some NewGuide'

4. Push to the branch

   git push origin feature/NewGuide

5. Open a pull request

License

Distributed under the Unlicense License. See LICENSE for more information.

Contributors