Skip to content

Commit

Permalink
docs: minor fixes in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Bionus committed Jan 14, 2024
1 parent 1eb8755 commit 21b07a5
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
6 changes: 3 additions & 3 deletions docs/docs/plugins/theme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 4 additions & 6 deletions docs/docs/sites/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 change: 1 addition & 0 deletions docs/docs/sites/source-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 21b07a5

Please # to comment.