WindyMadman/imgbrd-grabber
1
0
Fork 0
mirror of https://github.com/Bionus/imgbrd-grabber.git synced 2025-01-08 11:47:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: minor fixes in the docs

Browse Source
This commit is contained in:
Bionus 2024-01-14 12:32:45 +01:00
parent 1eb8755121
commit 21b07a5090
No known key found for this signature in database
GPG Key ID: 54B0B2DE713AE915
3 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/docs/plugins/theme.md
View File

@ -7,9 +7,9 @@ title: Themes
You can add Qt themes to Grabber, using [CSS](https://en.wikipedia.org/wiki/CSS) to customize all parts of the UI.
To add a new theme to Grabber, just create a folder in the `themes` directory (located in `C:/Users/%USERNAME%/AppData/Local/Bionus/Grabber` on Windows) with the name of your theme. Then create a `style.css` file inside that new folder. You just have to write your CSS into that file!
To add a new theme to Grabber, just create a folder in the `themes` directory (located in your [configuration directory](../configuration-files.md#location)) with the name of your theme. Then create a `style.css` file inside that new folder. You just have to write your CSS into that file!
The documentation for Qt's stylesheet can be found here:
https://doc.qt.io/qt-5/stylesheet-reference.html
The documentation for Qt's stylesheet can be found here:
<https://doc.qt.io/qt-5/stylesheet-reference.html>
If you made a nice theme that you feel could be added to the default Grabber installation, feel free to propose it to the team by making a pull request!

10
docs/docs/sites/index.md
View File

@ -6,19 +6,17 @@ permalink: /docs/sites/
## Based on an existing source type
If the site you're trying to add uses the same source type (e.g. Gelbooru 0.1) as already-supported sites, you're in luck as it should be easy to add it to Grabber.
1. Start the program.
2. Click on the "Sources" button at the bottom of a search tab
3. Click on the "Add" button at the bottom of the window that just popped up
4. Fill the Url field, and leave the "Guess" checkbox checked
5. If an error occurs, uncheck "Guess", and choose a source type manually in the list
!!! warning
If Shimmie-based boards are currently supported, a lot of them are still buggy, so beware when using them
5. If the program fails to guess the source type, uncheck "Guess", and choose a source type manually in the list
## Create a new source type
If none of the available sources types match the website you want to add, you'll have to create one yourself.
See [this documentation](source.md) for more info.
You can see [this documentation](source.md) for more info.

1
docs/docs/sites/source-example.md
View File

@ -95,6 +95,7 @@ export const source: ISource = {
```
We can see a few things here:
* The `name` field is quite obvious, we just use "JSON" because that's the format used by this API
* The `auth` field is left as an empty array, because even anonymous users can use this API, no authentication is required
* The `search` object contains two functions, `url()` and `parse()` that we will now discuss in more detail