Overview page

This commit is contained in:
purple_emily
2024-03-10 11:40:57 +00:00
parent ddc038974e
commit 5def66858f
7 changed files with 97 additions and 0 deletions

View File

@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<variables></variables>
<build-profile instance="hi">
<variables>
<noindex-content>true</noindex-content>
</variables>
</build-profile>
</buildprofiles>

Binary file not shown.

After

Width:  |  Height:  |  Size: 568 KiB

12
docs/Writerside/kc.tree Normal file
View File

@@ -0,0 +1,12 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE instance-profile
SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
<instance-profile id="kc" name="Knight Crawler"
start-page="Overview.md">
<toc-element topic="Overview.md"/>
<toc-element topic="How-to.md">
</toc-element>
<toc-element topic="Supported-Debrid-services.md"/>
</instance-profile>

View File

@@ -0,0 +1,37 @@
# How to
A How-to article is an action-oriented type of document.
It explains how to perform a specific task or solve a problem, and usually contains a sequence of steps.
Start with a short introductory paragraph that explains what users will accomplish by following this procedure,
what they need to perform it for, or define the target audience of the doc.
> **Highlight important information**
>
> You can change the element to *tip* or *warning* by renaming the style attribute below.
>
{style="note"}
## Before you start
It is good practice to list the prerequisites that are required or recommended.
Make sure that:
- First prerequisite
- Second prerequisite
## How to perform a task
Some introductory information.
1. Step with a code block
```bash
run this --that
```
2. Step with a [link](https://www.jetbrains.com)
3. Step with a list.
- List item
- List item
- List item

View File

@@ -0,0 +1,25 @@
# Overview
<img alt="The image shows a Knight in silvery armour looking forwards." src="knight-crawler-logo.png" title="Knight Crawler logo" width="100"/>
Knight Crawler is a self-hosted [Stremio](https://www.stremio.com/) addon for streaming torrents via a [Debrid](Supported-Debrid-services.md "Click for a list of Debrid services we support") service.
We are active on [Discord](https://discord.gg/8fQdxay9z2) for both support and casual conversation.
> Knight Crawler is currently alpha software.
>
> Users are responsible for ensuring their data is backed up regularly.
>
> Please read the changelogs before updating to the latest version.
>
{style="warning"}
## What does Knight Crawler do?
Knight Crawler is an addon for [Stremio](https://www.stremio.com/). It began as a fork of the very popular [Torrentio](https://github.com/TheBeastLT/torrentio-scraper) addon. Knight crawler essentially does the following:
1. It searches the internet for available films and tv shows.
2. It collects as much information as it can about each film and tv show it finds.
3. It then stores this information to a database for easy access.
When you choose on a film or tv show to watch on Stremio, a request will be sent to your installation of Knight Crawler. Knight Crawler will query the database and return a list of all the copies it has stored in the database as Debrid links. This enables playback to begin immediately for your chosen media.

View File

@@ -0,0 +1,3 @@
# Supported Debrid services
Start typing here...

View File

@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">
<ihp version="2.0">
<topics dir="topics" web-path="topics"/>
<images dir="images" web-path="images"/>
<instance src="kc.tree"/>
</ihp>