Skip to content

Commit 9abaab5

Browse files
committed
fix: fixed logo and improved docs on subs and homepage
1 parent 373e854 commit 9abaab5

File tree

6 files changed

+76
-9
lines changed

6 files changed

+76
-9
lines changed

docs/images/icon.png

5.6 KB
Loading

docs/images/riven.svg

Lines changed: 11 additions & 0 deletions
Loading

docs/index.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@ hide:
5959
</a>
6060
</div>
6161

62+
!!! riven "Riven"
63+
**Riven** is a powerful media management and streaming solution designed to integrate with various media servers and third-party services. It automates the process of finding, downloading, and organizing media content, making it instantly available for streaming through your preferred media server.
64+
6265
<div class="grid cards" markdown="1" style="justify-content: center;" id="home-cards">
6366

6467
- :gear: __Easy Installation__
@@ -99,13 +102,10 @@ hide:
99102

100103
---
101104

102-
103105
# Getting Started
104106

105107
![step-5](images/onboard/final.png)
106108

107-
**Riven** is an advanced media management and streaming solution designed to integrate with various media servers and third-party services. It automates the process of finding, downloading, and organizing media content, making it instantly available for streaming through your preferred media server.
108-
109109
!!! note "Beta"
110110
Riven is under active development, we are constantly working on new features and fixing bugs.
111111

@@ -164,6 +164,12 @@ Grab the `docker-compose.yml` file from the [installation guide](#installation)
164164

165165
For detailed information on the various services and configurations available in Riven, please refer to the [symlink](services/symlink/index.md) page. This page will help you understand how to configure and manage your media library using symlinks. It will help you understand why we map the Riven volumes to `/mnt` and how you can modify this in the `docker-compose.yml` file for the best outcome.
166166

167+
!!! danger "Setup Rclone & Symlink Paths First! :fire:"
168+
169+
This is incredibly important and must be setup first! When configuring the rclone mount path and library path, you need to make sure that the paths are correct for your system. More information can be found at the [symlink](services/symlink/index.md) page.
170+
171+
If your debrid files are found in your rclone path, and you can successfully `ls -lh /mnt/zurg` your rclone path, you can skip this step.
172+
167173
---
168174

169175
## Installation

docs/services/subtitles/index.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ OpenSubtitles is a popular subtitle provider.
3636

3737
- **enabled** (boolean): Boolean value to enable or disable the provider. Default is false.
3838
- Example: `false`
39-
- **username** (string): The username for accessing OpenSubtitles.
39+
- **username** (string): The username for accessing OpenSubtitles. *(Optional)*
4040
- Example: `"your_username"`
41-
- **password** (string): The password for accessing OpenSubtitles.
41+
- **password** (string): The password for accessing OpenSubtitles. *(Optional)*
4242
- Example: `"your_password"`
4343

4444
### **OpenSubtitles.com**
@@ -47,11 +47,20 @@ OpenSubtitles.com is another popular subtitle provider.
4747

4848
- **enabled** (boolean): Boolean value to enable or disable the provider. Default is false.
4949
- Example: `false`
50-
- **username** (string): The username for accessing OpenSubtitles.com.
50+
- **username** (string): The username for accessing OpenSubtitles.com. *(Optional)*
5151
- Example: `"your_username"`
52-
- **password** (string): The password for accessing OpenSubtitles.com.
52+
- **password** (string): The password for accessing OpenSubtitles.com. *(Optional)*
5353
- Example: `"your_password"`
5454

55+
!!! riven "Optional Authentication"
56+
57+
OpenSubtitles and OpenSubtitles.com don't require additional authentication and can be used once enabled.
58+
59+
!!! note "How Subliminal Works"
60+
61+
Subliminal is a powerful library that works by searching for subtitles in your media library and downloading them. It uses the configured providers to search for and download subtitles. You can find more information as to how providers work [here](https://subliminal.readthedocs.io/en/latest/user/how_it_works.html).
62+
63+
5564
### **How Subtitles Work**
5665

5766
Riven uses the Subliminal library to handle subtitles. When enabled, Subliminal will scan your media library for video files and download the best available subtitles in the specified languages. Here is a brief overview of how the process works:

mkdocs.yml

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ plugins:
2626

2727
theme:
2828
name: 'material'
29+
logo: images/icon.png
2930
custom_dir: overrides
3031
features:
3132
- navigation.tabs
@@ -44,10 +45,24 @@ theme:
4445
- content.code.copy
4546
- content.tabs.link
4647
- announce.dismiss
48+
- header.autohide
4749
# - content.action.edit
50+
4851
icon:
49-
logo: github
5052
repo: fontawesome/brands/github
53+
admonition:
54+
note: fontawesome/solid/note-sticky
55+
abstract: fontawesome/solid/book
56+
info: fontawesome/solid/circle-info
57+
tip: fontawesome/solid/bullhorn
58+
success: fontawesome/solid/check
59+
question: fontawesome/solid/circle-question
60+
warning: fontawesome/solid/triangle-exclamation
61+
failure: fontawesome/solid/bomb
62+
danger: fontawesome/solid/skull
63+
bug: fontawesome/solid/robot
64+
example: fontawesome/solid/flask
65+
quote: fontawesome/solid/quote-left
5166

5267
palette:
5368
- media: "(prefers-color-scheme)"
@@ -75,7 +90,7 @@ extra:
7590
- icon: 'fontawesome/brands/github'
7691
link: 'https://github.com/rivenmedia/riven'
7792
- icon: 'fontawesome/solid/heart'
78-
link: 'https://github.com/sponsors/rivenmedia'
93+
link: 'https://github.com/sponsors/dreulavelle'
7994
text: 'Sponsor us on GitHub'
8095

8196
markdown_extensions:
@@ -91,6 +106,7 @@ markdown_extensions:
91106
- pymdownx.emoji:
92107
emoji_index: !!python/name:material.extensions.emoji.twemoji
93108
emoji_generator: !!python/name:material.extensions.emoji.to_svg
109+
- pymdownx.details
94110
- pymdownx.superfences:
95111
custom_fences:
96112
- name: mermaid

overrides/stylesheets/extra.css

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,3 +71,28 @@ h1, h2, h3, h4, h5, h6 {
7171
transform: translateY(0);
7272
}
7373
}
74+
75+
/* Remove border from admonitions */
76+
.md-typeset .admonition,
77+
.md-typeset details {
78+
/* border-width: 0; */
79+
border-left-width: 4px;
80+
}
81+
82+
:root {
83+
--md-admonition-icon--riven: url('../images/icon.png');
84+
}
85+
.md-typeset .admonition.riven,
86+
.md-typeset details.riven {
87+
border-color: rgb(43, 155, 70);
88+
}
89+
.md-typeset .riven > .admonition-title,
90+
.md-typeset .riven > summary {
91+
background-color: rgba(43, 155, 70, 0.1);
92+
}
93+
.md-typeset .riven > .admonition-title::before,
94+
.md-typeset .riven > summary::before {
95+
background-color: rgb(255, 255, 255);
96+
-webkit-mask-image: var(--md-admonition-icon--riven);
97+
mask-image: var(--md-admonition-icon--riven);
98+
}

0 commit comments

Comments
 (0)