Merge branch 'Snaacky:master' into master

.github/workflows/links.yml

@@ -0,0 +1,43 @@
+name: Links
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * 0"
+
+jobs:
+  linkChecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Link Checker
+        id: lychee
+        uses: lycheeverse/[email protected]
+        with:
+          args: >-
+            --exclude-all-private
+            --verbose --no-progress
+            --user-agent 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36'
+            --max-redirects 10
+            --header "accept=*/*"
+            --accept 200,204,206,403,429
+            --base 'https://thewiki.moe'
+            --exclude-path './docs/hidden'
+            --exclude '^https://www.amd.com'
+            --exclude '^https://exhentai.org'
+            --exclude '^https://www.nzbking.com'
+            './**/*.md'
+
+#           Public trackers, streaming sites, crunchyroll, kodi, qbittorrent, etc return 403
+#           Nyaa returns 429
+#           ./docs/hidden has unmaintained legacy files
+#           AMD fails for reasons unknown to me, exhentai is private, and nzbking has bad uptime
+
+      - name: Create Issue From File
+        if: env.lychee_exit_code != 0
+        uses: peter-evans/create-issue-from-file@v4
+        with:
+          title: Link Checker Report
+          content-filepath: ./lychee/out.md
+          labels: report, automated issue

.gitignore

@@ -0,0 +1,2 @@
+
+retype.manifest

README.md

@@ -1,15 +1,119 @@
-# thewiki
-Retype docs for thewiki.moe
+<p align="center">
+    <a href="https://thewiki.moe">
+      <img src="https://github.com/Snaacky/thewiki/blob/master/docs/static/readme/logo-thin-border.png" alt="thewiki.moe Logo" width="200" height="200">
+    </a>
+    <h3 align="center">thewiki.moe</h3>
+    <p align="center">
+      Retype docs for thewiki.moe, a wiki for all things related to anime and more.
+      <br>
+      <a href="https://thewiki.moe/"><strong>Explore the wiki »</strong></a>
+      <br>
+    </p>
+  </p>
 
-## How to edit
+<div align="center">
 
-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)
+[![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/workflows/retype-action.yml) [![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/Snaacky/thewiki/links.yml?logo=github&label=links)](https://github.com/Snaacky/thewiki/actions/workflows/links.yml)
+ [![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)
 
-## 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>
+
+## Table Of Contents
+
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+  - [Installation](#installation)
+- [Contributing](#contributing)
+- [License](#license)
+- [Contributors](#contributors)
+
+## Getting Started
+
+thewiki is built using [Retype](https://retype.com). See how you can host a local copy on your machine:
+
+### Prerequisites
+
+- [Node.js](https://nodejs.org/en) - *This can be installed with [`nvm`](https://github.com/nvm-sh/nvm) or [`nvm-windows`](https://github.com/coreybutler/nvm-windows) depending on your OS*
+
+- To install with `nvm`, run the following in your terminal:
+
+  ```sh
+  nvm install latest
+  ```
+
+  ```sh
+  nvm use latest
+  ```
+
+### Installation
+
+1. Install [retypeapp](https://www.npmjs.com/package/retypeapp). You can install it using [`npm`](https://www.npmjs.com) or [`yarn`](https://yarnpkg.com):
+
+   ```sh
+   npm install retypeapp --global
+   ```
+
+   ```sh
+   yarn global add retypeapp
+   ```
+
+2. Clone this repo:
+
+   ```sh
+   git clone https://github.com/Snaacky/thewiki.git
+   ```
+
+3. Build and run:
+
+   - The `retype start` command automatically prepares 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
+
+Contributions are **much 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 create a [pull request](https://github.com/Snaacky/thewiki/pulls)
+- 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
+
+   ```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://choosealicense.com/licenses/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>