chore: Update landing page title and footer links

This commit is contained in:
Mauro Balades 2024-08-18 01:45:13 +02:00
parent ca6d507ec7
commit b6d746d984
8 changed files with 76 additions and 20 deletions

2
.github/FUNDING.yml vendored
View file

@ -1 +1 @@
github: [jackyzha0]
patreon: [zen_browser]

View file

@ -2,6 +2,39 @@
title: Building Zen Browser
---
* [Linux](building-zen-browser/linux.md)
* [Windows](building-zen-browser/windows.md)
* [macOS](building-zen-browser/macos.md)
> We cannot provide support if a build fails. Please understand this before proceeding with the following steps.
We've took the time to make building Zen Browser as easy as possible, independent of your operating system or technical knowledge.
1. Clone the repository
```bash
git clone https://github.com/zen-browser/desktop.git
cd desktop
```
2. Install dependencies
```bash
npm install
```
3. Download and bootstrap the browser
```bash
npm run init
```
4. Start building the browser
> This may take a while, depending on your internet connection and computer speed.
```bash
npm run build
```
5. Start the browser!
```bash
npm start
```

View file

@ -1,3 +0,0 @@
---
title: Themes Store
---

View file

@ -1,3 +0,0 @@
---
title: Building Zen Browser on Linux
---

View file

@ -1,3 +0,0 @@
---
title: Building Zen Browser on MacOS
---

View file

@ -1,3 +0,0 @@
---
title: Building Zen Browser on Windows
---

View file

@ -5,6 +5,3 @@ title: Welcome to Zen Browser's Documentation
* [Themes Store](themes-store/themes-marketplace.md)
* [Building Zen Browser](building-zen-browser/building-zen-browser.md)
* [Linux](building-zen-browser/linux.md)
* [Windows](building-zen-browser/windows.md)
* [macOS](building-zen-browser/macos.md)

View file

@ -1,3 +1,41 @@
---
title: Themes Store Preferences
---
When submitting a theme to the Zen Browser Themes Store, you can use custom preferences to define the theme's appearance and behavior. These preferences are stored in a JSON file named `preferences.json` and are located in the root directory of the theme.
The following is an example of a `preferences.json` file:
```json
{
"uc.example-preference.enabled": "This is an example preference",
"uc.example-preference.value": "This is an example value"
}
```
Preference's schema must be defined with a key-value pair. The key must be in the format of firefox's preference name schema and the value must be a string, describing the preference. Right now, the only supported preference value types are booleans but that might change.
## How to use preferences
Let's say you have a theme that changes the background color of the browser. You can create a preference to allow users to decide whether they want a light or dark background. Here's how you can define the preference in the `preferences.json` file:
```json
{
"uc.theme.dark-background.enabled": "Enable dark background",
}
```
In the theme's CSS file, you can use the preference to change the background color. Here's an example:
```css
@media (-moz-bool-pref: "uc.theme.dark-background.enabled") {
body {
background-color: #000;
color: #fff;
}
}
```
This settings will appear on the preferences page of the theme in the Zen Browser settings. Users can enable or disable the preference to change the background color of the browser.
> Note: Other values such as strings or numbers may be supported in the future. For now, only booleans are supported.