|
|
<h1>Documentation/Manual</h1>
|
|
|
<h2>Basics</h2>
|
|
|
<p>
|
|
|
the bird-browser is a tabbing browser such as firefox or google-chrome, just way lighter.<br>
|
|
|
Most of the input comes from the mouse with creating tabs, switching between tabs, interacting with the webview and closing tabs.<br>
|
|
|
An Adblocker is built-in so you don't have to worry about that.<br>
|
|
|
Later you can load and create bookmarks and also store passwords (safely of course)<br>
|
|
|
Those options will be avaiable in the menubar<br>
|
|
|
You can use the search-engine-integration by typing in <code>search://the thing you want to know</code><br>
|
|
|
You can also add external search engines in the configuration file<br>
|
|
|
</p>
|
|
|
<h2>Configuring the browser</h2>
|
|
|
<p>
|
|
|
on each launch the browser looks for a config-file. If he doesn't find it he creates it.<br>
|
|
|
The browser looks for the file in <code>.config/bird/bird.config.json</code> of your home directory.<br>
|
|
|
on default the file looks like this:<br>
|
|
|
<pre>
|
|
|
{
|
|
|
"search-engine": "https://duckduckgo.com/?q={search}",
|
|
|
"startup-url": "https://duckduckgo.com"
|
|
|
}
|
|
|
</pre><br>
|
|
|
<code>{search}</code> represents your search that you put into the url-bar.<br>
|
|
|
The startup-url gets loaded every time a new tab gets created.<br>
|
|
|
You can also add other things for example: <code>"additional-search-engines"</code>
|
|
|
This option works like this: <br><code>
|
|
|
"additional-search-engines": {"NAME://": "URL_INCLUDING_{search}"}</code><br>
|
|
|
now each time you try visiting <code>NAME://your search</code> it gets translated to an actual search on this webpage<br>
|
|
|
You also can specify the colors of the browser<br>
|
|
|
The syntax here is like this:<code><br>
|
|
|
"style":{"color": "your color for the text", "background-color": "your color for the background"}</code><br>
|
|
|
The sysntax of the colors is css<br>
|
|
|
</p>
|
|
|
<h2>Bookmarking</h2>
|
|
|
<p>
|
|
|
Bookmarking is currently integrated into the search bar.<br>
|
|
|
In order to load a bookmark type in: <code>bookmarks://NAME</code><br>
|
|
|
Currently you can't list all the bookmarks that have been taken so long but that will be added<br>
|
|
|
In order to bookmark any page type in: <code>bookmark://NAME|URL</code><br>
|
|
|
<code>URL</code> can be replaced with a <code>-</code> this will add the currently viewed page's url to the bookmark<br>
|
|
|
</p> |
|
|
\ No newline at end of file |