Skip to content

Commit a1e84ae

Browse files
committed
feat: copy docs from readme
1 parent 06461c9 commit a1e84ae

26 files changed

+271
-165
lines changed

.vitepress/config.mts

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,32 @@ import { defineConfig } from "vitepress";
44
export default defineConfig({
55
title: "Cascade Docs",
66
description: "A responsive One-Line CSS Theme for Firefox",
7+
srcDir: "./src",
78
themeConfig: {
89
// https://vitepress.dev/reference/default-theme-config
910
nav: [
1011
{ text: "Home", link: "/" },
11-
{ text: "Examples", link: "/markdown-examples" },
12+
{ text: "Install", link: "/installation" },
13+
{ text: "Guide", link: "/customisation" },
1214
],
1315

1416
sidebar: [
1517
{
16-
text: "Examples",
1718
items: [
18-
{ text: "Markdown Examples", link: "/markdown-examples" },
19-
{ text: "Runtime API Examples", link: "/api-examples" },
19+
{ text: "About", link: "/about" },
20+
{ text: "Installation", link: "/installation" },
21+
{ text: "Customisation", link: "/customisation" },
22+
{ text: "Integrations", link: "/integrations" },
23+
{ text: "Keyboard Shortcuts", link: "/shortcuts" },
2024
],
2125
},
2226
],
2327

24-
socialLinks: [
25-
{ icon: "github", link: "https://github.com/vuejs/vitepress" },
26-
],
28+
socialLinks: [{ icon: "github", link: "https://github.com/cascadefox" }],
29+
30+
footer: {
31+
message: "Released under the MIT license.",
32+
copyright: "Copyright © 2022-present",
33+
},
2734
},
2835
});

.vitepress/theme/index.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import DefaultTheme from "vitepress/theme";
2+
import "@catppuccin/vitepress/theme/macchiato/teal.css";
3+
4+
export default DefaultTheme;

api-examples.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

index.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

markdown-examples.md

Lines changed: 0 additions & 85 deletions
This file was deleted.

src/about.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# About Cascade
2+
3+
![Cascade Preview](preview.webp)
4+
5+
6+
<div style="display: flex; justify-content: center; gap: 1rem;">
7+
<a href="https://github.com/42willow/wallpapers/stargazers">
8+
<img
9+
alt="Stargazers"
10+
src="https://img.shields.io/github/stars/cascadefox/cascade?style=for-the-badge&logo=starship&color=7dc4e4&logoColor=white&labelColor=363a4f"
11+
/></a>
12+
<a href="https://github.com/42willow/wallpapers">
13+
<img
14+
alt="Repo Size"
15+
src="https://img.shields.io/discord/837559961194070026?label=FFCSS+Discord&style=for-the-badge&logo=discord&color=a6da95&logoColor=white&labelColor=363a4f"
16+
/></a>
17+
<a href="https://github.com/42willow/wallpapers/issues">
18+
<img
19+
alt="Issues"
20+
src="https://img.shields.io/github/issues/42willow/wallpapers?style=for-the-badge&logo=gitbook&color=f5a97f&logoColor=white&labelColor=363a4f"
21+
/></a>
22+
</div>
23+
24+
<br>
25+
26+
This theme was known previously as »*ag.proton*« — but let's be honest: That sounds hella boring. What you get is a really simple adaptive layout that works well with the new Proton UI. By default — on larger screen resolutions – Cascade will transition to a Oneline layout which displays the URL Bar and Tab Bar next to each other. Smaller resultions will stack both UI elements on top of each other for better readability.
27+
28+
<br>
29+
30+
> If you *really* like my work you can buy me a coffee to fuel further development.<br>
31+
> While appreciated it's ofc by no means necessary. ♡<br><br>
32+
> [![Buy me a Coffee <3](https://img.shields.io/static/v1?label=&message=Buy%20me%20a%20Coffee&style=for-the-badge&color=e6e9ef&labelColor=ccd0da&logo=kofi)](https://ko-fi.com/andreasgrafen)
33+
34+
\- [@unseen-ninja](https://github.com/unseen-ninja)

src/customisation.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Customise Cascade to your liking
2+
3+
> [!TIP]
4+
> If you're using Cascade I highly recommend to remove all clutter from the Navigation Bar area. To do so rightclick your bar and go into the customisation settings. You can move all the icons freely which allows you to place your Addons within the Personal Toolbar for example.
5+
6+
<br>
7+
8+
## Colours
9+
10+
By default Cascade loads it's own colours which can be customised to fit your desired by simply changing the [colours include](https://github.com/cascadefox/cascade/tree/main/chrome/includes/cascade-colours.css).
11+
If you want to use Cascade with the Browsers default colours, or custom Firefox Themes like [Firefox Color](https://color.firefox.com) or even Addons like [Adaptive Tab Bar Color](https://github.com/YS-Wong/Adaptive-Tab-Bar-Color) simply remove the [colours include](https://github.com/cascadefox/cascade/tree/main/chrome/includes/cascade-colours.css) from the [userChrome.css](https://github.com/cascadefox/cascade/tree/main/chrome/userChrome.css) file.
12+
13+
> [!NOTE]
14+
> **Are you having issues with the colours not applying?**
15+
>
16+
> A workaround fix for this issue is to remove the colour include from the [main file](https://github.com/cascadefox/cascade/tree/main/chrome/userChrome.css) and use [Firefox Color](https://addons.mozilla.org/en-GB/firefox/addon/firefox-color/) to apply [this custom theme](https://color.firefox.com/?theme=XQAAAAL8AAAAAAAAAABBKYhm849SCia2CaaEGccwS-xMDPr15o6H0LddKi1zZz7p7H23MOXwiWJCP8Eczt9O0cwm8bbmvpd20uiOFG8WawCZcXzraYdfXj2HrWgd4IgJK7QchIStW1KXpQGYxo9DHahUGJEmoKprdWRKoHPzcBH145YsTnnZq5DK71QEUg2RSwksm6Vs6Y7i7Y-4K-wFjfvAbb__jUJAAA) to apply Cascades default colours.
17+
18+
<br>
19+
20+
## Mouse Support
21+
22+
Cascade offers an [alternative config file](https://github.com/cascadefox/cascade/tree/main/chrome/includes/cascade-config-mouse.css) that reintroduces some of the UI elements that are necessary to use Firefox with a mouse. To use these settings simply substitue the regular config include with the one for mouse support.
23+
24+
This config brings back:
25+
* Navigation Buttons
26+
* the URL Bar Bookmark Button
27+
* the Hamburger Menu
28+
* Tab Close Buttons (on hover)
29+
30+
If the buttons inside the URL Bar are off you may need to change the `--uc-page-action-margin` variable in the config as the necessary margin seems to differ depending on ones setup.
31+
32+
<br>
33+
34+
## Sort the UI like you want it
35+
36+
In the [Cascade config](https://github.com/cascadefox/cascade/tree/main/chrome/includes/cascade-config.css) you can set different ways of how the UI elements are layed out. The URL Bar, Tab Bar and Personal Toolbar can be arranged in different stacks; do you want the Toolbar to be on top or the URL and Tab Bar? Tabs on the left with the URL Bar to the right? No problem!
37+
38+
```css
39+
/* Position of the Personal Toolbar
40+
* possible values:
41+
* 0 – toolbar on top
42+
* 4 – toolbar on bottom
43+
*/ --uc-toolbar-position: 0;
44+
```
45+
46+
```css
47+
/* Position of the URL Bar
48+
* possible values:
49+
* 1 – tabs on the right
50+
* 3 – tabs on the left
51+
*/ --uc-urlbar-position: 1;
52+
```
53+
54+
<details>
55+
<summary>Previews</summary>
56+
57+
Toolbar on the top
58+
![Toolbar on the top](cascade-toolbar-top.webp)
59+
Toolbar on the bottom
60+
![Toolbar on the bottom](cascade-toolbar-bottom.webp)
61+
URL bar on the right
62+
![URL Bar on the right](cascade-urlbar-right.webp)
63+
64+
</details><br>
65+
66+
## URL Bar Customisation
67+
68+
You can freely set your desired URL Bar width from within the [config](https://github.com/cascadefox/cascade/tree/main/chrome/includes/cascade-config.css) where the `min-width` setting is the default URL Bar width and `max-width` is the width of the focused URL Bar. Those can be different in order to make more room for the URL Bar when you actually want to use it.
69+
70+
```css
71+
/* Width of the URL Bar for the Oneline layout
72+
* If enabled the max-width is applied on focus
73+
* otherwise the URL Bar will always be it's min-width
74+
*/ --uc-urlbar-min-width: 30vw;
75+
--uc-urlbar-max-width: 45vw;
76+
```
77+
78+
If you set the `min-width` to `0vw` and the `max-width` to `100vw` you can also completely hide the URL Bar as long as it's not focused.
79+
80+
![Fully hidden URL Bar if unfocused](cascade-urlbar.webp)
81+
82+
<br>
83+
84+
## Oneline Breakpoint
85+
86+
If you'd like to have Cascade transition into it's Oneline layout on either smaller or larger sizes you can simply do so by changing the breakpoint value in the [responsive include](https://github.com/cascadefox/cascade/tree/main/chrome/includes/cascade-responsive.css) file. If you don't want Cascade to break to the Oneline layout at all remove it from the [userChrome.css](https://github.com/cascadefox/cascade/tree/main/chrome/userChrome.css) file
87+
88+
```css
89+
@media (min-width: 1000px) {
90+
91+
[]
92+
93+
}
94+
```
95+
96+
<br><br><br>

src/index.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
# https://vitepress.dev/reference/default-theme-home-page
3+
layout: home
4+
5+
hero:
6+
name: "Cascade"
7+
tagline: "A minimalistic and keyboard centered userChrome"
8+
actions:
9+
- theme: brand
10+
text: Install
11+
link: /installation
12+
- theme: alt
13+
text: GitHub
14+
link: https://github.com/cascadefox/cascade
15+
16+
features:
17+
- icon: ⚙️
18+
title: Customisable
19+
details: From the colours to the layout, customise Cascade to your liking
20+
- icon: 🌱
21+
title: Minimalist
22+
details: Cascade aims to remove a lot of the subjective clutter default Firefox comes with.
23+
- icon: 🤝
24+
title: Open source
25+
details: Made with love with the source code available on GitHub
26+
---
27+
28+
29+
<br>
30+
31+
![Cascade Preview](preview.webp)

src/installation.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Installation
2+
3+
1. Type `about:config` into your URL bar. Click on the **I accept the risk** button if you're shown a warning.
4+
2. Seach for **`toolkit.legacyUserProfileCustomizations.stylesheets`** and set it to **`true`**.
5+
3. Go to your profile folder:
6+
- Linux: `$HOME/.mozilla/firefox/######.default-release/`
7+
- MacOS: `Users/[USERNAME]/Library/Application Support/Firefox/Profiles/######.default-release`
8+
- Windows: `C:\Users\[USERNAME]\AppData\Roaming\Mozilla\Firefox\Profiles\######.default-release`
9+
4. Copy the `chrome` folder into your profile and restart<sup>1)</sup> Firefox.
10+
5. Customise everything to your liking. (*optional*)
11+
12+
<sup>1) If you're running into trouble with a restart seemingly not working you can navigate to `about:profiles` and click the »*Restart Normally*«-Button.</sup>
13+
14+
<br>
15+
16+
> [!IMPORTANT]
17+
> **Attention Windows users**
18+
>
19+
> It seems like `flexbox` (within the Firefox UI) is inheritly broken on Windows. In order to fix the One-Line layout on windows please substitute the [responsive include](https://github.com/cascadefox/cascade/tree/main/chrome/includes/cascade-responsive.css) with the [version for windows](https://github.com/cascadefox/cascade/tree/main/chrome/includes/cascade-responsive-windows-fix.css). This will ensure that the layout doesn't break **but** since it can't use `flexbox` the UI reordering does **not** work.<br>

0 commit comments

Comments
 (0)