this repo has no description
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

lowercase readme

0xda157 e877ac1a 4c38e1f6

+66 -54
+66 -54
README.md
··· 1 - # Potatofox 2 - [![Please don't upload to GitHub](https://nogithub.codeberg.page/badge.svg)](https://nogithub.codeberg.page) 1 + # potatofox 2 + [![please don't upload to github](https://nogithub.codeberg.page/badge.svg)](https://nogithub.codeberg.page) 3 3 4 4 <div style="display: flex;"> 5 5 <div style="flex: 1;"> 6 6 7 - A Firefox and Sidebery CSS theme. 7 + a firefox and sidebery css theme. 8 8 9 - > [!NOTE] 10 - > Only Linux is supported, macOS and Windows should work but may have 9 + > [!note] 10 + > only linux is supported, macos and windows should work but may have 11 11 > issues. 12 12 13 - ## Features 13 + ## features 14 14 15 - - collapsing vertical tabs using Sidebery 15 + - collapsing vertical tabs using sidebery 16 16 - pop-up arc-like urlbar 17 17 - option to hide the navbar 18 18 - ability to remove borders around webpage for an ultra minimal experience 19 19 - general visual enhancements 20 - - custom SVG icons for some extensions 20 + - custom svg icons for some extensions 21 21 - support for vertical tabs on the left or right 22 22 - tons for blur and translucency 23 23 24 24 </div> 25 25 26 26 <div style="flex: 1;"> 27 - <img src="./media/screenshot0.png" width="100%" alt="Firefox with Custom CSS applied"> 27 + <img src="./media/screenshot0.png" width="100%" alt="firefox with custom css applied"> 28 28 </div> 29 29 </div> 30 30 31 - ## Screenshots 31 + ## screenshots 32 32 33 33 <div align="center"> 34 34 <img src="./media/screenshot1.png" width="49%" alt="potatofox theme with sidebar collapsed"> ··· 38 38 <img src="./media/screenshot5.png" width="32%" alt="borderless potatofox theme with navbar and sidebar hidden"> 39 39 </div> 40 40 41 - ## Install Instructions 41 + ## install instructions 42 42 43 - Extension: 43 + extension: 44 44 45 - - [Sidebery](https://addons.mozilla.org/en-US/firefox/addon/sidebery) 46 - - [Userchrome Toggle Extended](https://addons.mozilla.org/en-US/firefox/addon/userchrome-toggle-extended) 47 - - [Firefox Color](https://addons.mozilla.org/en-US/firefox/addon/firefox-color) (optional) 45 + - [sidebery](https://addons.mozilla.org/en-us/firefox/addon/sidebery) 46 + - [userchrome toggle extended](https://addons.mozilla.org/en-us/firefox/addon/userchrome-toggle-extended) 47 + - [firefox color](https://addons.mozilla.org/en-us/firefox/addon/firefox-color) (optional) 48 48 49 - Open the [releases tab](https://codeberg.org/da157/PotatoFox/releases) and download the correct release for your version of Firefox (Urlbar > about:support > Application Basics > Version). Then copy the chrome directory and user.js file into your Firefox profiles directory (about:support > Application Basics > Profile Directory), then restart Firefox. 49 + open the [releases tab](https://codeberg.org/da157/potatofox/releases) and download the correct release for your version of firefox 50 + (urlbar > about:support > application basics > version). then copy the chrome directory 51 + and user.js file into your firefox profiles directory 52 + (about:support > application basics > profile directory), then restart firefox. 50 53 51 - <details><summary>Advanced (cli) install (macOS/Linux)</summary> 54 + <details><summary>advanced (cli) install (macos/linux)</summary> 52 55 53 - #### Using git 56 + #### using git 54 57 55 58 ```bash 56 59 git clone https://codeberg.org/da157/potatofox.git 57 60 cd potatofox 58 - ln -sr user.js chrome ~/.mozilla/firefox/<profile> # Linux 59 - cp -r user.js chrome ~/Library/Application Support/Firefox/Profiles/<profile> # macOS 61 + ln -sr user.js chrome ~/.mozilla/firefox/<profile> # linux 62 + cp -r user.js chrome ~/library/application support/firefox/profiles/<profile> # macos 60 63 ``` 61 64 62 - #### Using [Nyoom](https://github.com/ryanccn/nyoom) 65 + #### using [nyoom](https://github.com/ryanccn/nyoom) 63 66 64 67 ```bash 65 68 nyoom profile <profile-dir> ··· 67 70 nyoom switch potatofox 68 71 ``` 69 72 70 - > [!NOTE] 71 - > Make sure to install the required extensions. 73 + > [!note] 74 + > make sure to install the required extensions. 72 75 73 76 </details> 74 77 75 - ## Post Install 78 + ## post install 76 79 77 - - Import Sidebery config (Sidebery Settings > Help > Import addon data) 78 - - Import Firefox Color [Theme](https://color.firefox.com/?theme=XQAAAAJLBAAAAAAAAABBqYhm849SCicxcUcPX38oKRicm6da8pG5gi-DrbS7fiEFLUzDsWXWyUHMSkHZ2PpRK_LvZGTF44fp7VnVXujpkKMjvOWQSIhdK22u1ZG2EgdMyNMx_0oKJ3H6SApxy3IyQ4DsJp5wXsJAe_-1mtfWgRDmsdoSCoijQWJMgbopoYEZC-RlLTcZGRDec_YbCL7rnqK6TAlv9HrKP2vKGFddbs2RHmpKmp4nTmraRv5vn93Xej36dJ4PJLs8lR2xW5gEjnC2yNLDH0ltCV_dOCQU1k6C8gqp4WDfYkereqQMlzloT6ayCj_r86A_oAdsjNzxh2Qs7OpWSWEmt1D06L1Xq2dYeaBXH9ZTiFsKY5cURy2M6x_Epyax9nYbJGEIEnsjyqDTYe4ssM-VVYSrKhHTFwcmZpvjIDgAiafTRbAL5lonNLHF9S7KkU6O9y9KVvR2ZCFf2v6tYSpyu0pLOZEFN9_9czNq4YY1eac1Ciaw-_h5RgHX3pDHDFrzk6gSI1tW-iLlTDyDu8f1rVKzRJNxgLE0yzDpy6-qm0ihyKgRX6UlVuRTm_5nV9WkMF0UeIzsABE_aBxh8cr_0f-fxA) (Optional) 79 - - about:addons (url) > Userchrome Toggle Extended preferences > General settings > allow multiple styles to be active together, apply changes 80 + - import sidebery config (sidebery settings > help > import addon data) 81 + - import firefox color [theme](https://color.firefox.com/?theme=xqaaaajlbaaaaaaaaabbqyhm849scicxcucpx38okricm6da8pg5gi-drbs7fiefluzdswxwyuhmskhz2pprk_lvzgtf44fp7vnvxujpkkmjvowqsihdk22u1zg2egdmynmx_0okj3h6sapxy3iyq4dsjp5wxsjae_-1mtfwgrdmsdoscoijqwjmgbopoyezc-rlltczgrdec_ybcl7rnqk6talv9hrkp2vkgfddbs2rhmpkmp4ntmrarv5vn93xej36dj4pjls8lr2xw5gejnc2ynldh0ltcv_docqu1k6c8gqp4wdfykereqqmlzlot6aycj_r86a_oadsjnzxh2qs7opwswemt1d06l1xq2dyeabxh9ztifsky5cury2m6x_epyax9nybjgeiensjyqdtye4ssm-vvysrkhhtfwcmzpvjidgaiaftrbal5lonnlhf9s7kku6o9y9kvvr2zcff2v6tyspyu0plozefn9_9cznq4yy1eac1ciaw-_h5rghx3pdhdfrzk6gsi1tw-illtdydu8f1rvkzrjnxgle0yzdpy6-qm0ihykgrx6ulvurtm_5nv9wkmf0ueizsabe_abxh8cr_0f-fxa) (optional) 82 + - about:addons (url) > userchrome toggle extended preferences > 83 + general settings > allow multiple styles to be active together, apply changes 80 84 81 - > [!WARNING] 82 - > Some websites with a white background will have an incorrect background, this can be fixed by using [Dark Reader](https://addons.mozilla.org/firefox/addon/darkreader/) or by removing `browser.tabs.allow_transparent_browser` from `user.js` 85 + > [!warning] 86 + > some websites with a white background will have an incorrect background, this 87 + > can be fixed by using [dark reader](https://addons.mozilla.org/firefox/addon/darkreader/) 88 + > or by removing `browser.tabs.allow_transparent_browser` from `user.js` 83 89 84 - > [!TIP] 85 - > On Linux there may be extra padding before/after the window controls, this can be fixed by changing line 36-38 in `chrome/vars.css` 90 + > [!tip] 91 + > on linux there may be extra padding before/after the window controls, this can 92 + > be fixed by changing line 36-38 in `chrome/vars.css` 86 93 87 - > [!TIP] 88 - > If fingerprinting is a concern for you, I recommend enabling `uc.tweak.no-custom-icons` and removing `svg.context-properties.content.enabled` from `user.js` 94 + > [!tip] 95 + > if fingerprinting is a concern for you, i recommend enabling `uc.tweak.no-custom-icons` 96 + > and removing `svg.context-properties.content.enabled` from `user.js` 89 97 90 - ### Recommended Userchrome Toggle Extended settings 98 + ### recommended userchrome toggle extended settings 91 99 92 100 <div align="center"> 93 - <img src="./media/uc_toggle_settings.png" width="600" alt="Userchrome Toggle Settings"> 101 + <img src="./media/uc_toggle_settings.png" width="600" alt="userchrome toggle settings"> 94 102 </div> 95 103 96 104 ### about:config tweaks 97 105 98 - | Setting | Description | 106 + | setting | description | 99 107 | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | 100 108 | uc.tweak.borderless | removes margins around the webpage | 101 109 | uc.tweak.borderless.no-round | don't round corners of browser contents when in borderless mode 102 - | uc.tweak.no-custom-icons | Don't apply custom monochrome icons for some extensions | 103 - | uc.tweak.no-window-controls | Removes window controls | 110 + | uc.tweak.no-custom-icons | don't apply custom monochrome icons for some extensions | 111 + | uc.tweak.no-window-controls | removes window controls | 104 112 | uc.tweak.no-panel-hint | hide the small bars showing location of hidden panels | 105 113 | uc.tweak.no-animations | disable animations added by this theme | 106 114 | uc.tweak.urlbar.not-floating | urlbar no longer floats in center of window when focused | 107 115 | uc.tweak.findbar.bottom | moves findbar to bottom of webpage (causes it to not be visible when devtools are active on bottom) | 108 - | sidebar.position_start | Controls if the sidebar is on the left or right | 116 + | sidebar.position_start | controls if the sidebar is on the left or right | 109 117 | uc.tweak.sidebar.short | makes sidebar shorter when hovering (140px) | 110 118 | uc.tweak.sidebar.wide | makes sidebar wider when hovering (200px) | 111 119 | uc.tweak.sidebar.header | show sidebar header | 112 - | uc.tweak.sidebery.big-pinned | Pinned tabs look like buttons, like Arc's pinned tabs (make sure to set Sidebery settings > tabs > pinned tabs > Show titles is off) | 113 - | uc.tweak.sidebery.top-navbar | move Sidebery's navbar to the top of the sidebar | 120 + | uc.tweak.sidebery.big-pinned | pinned tabs look like buttons, like arc's pinned tabs (make sure to set sidebery settings > tabs > pinned tabs > show titles is off) | 121 + | uc.tweak.sidebery.top-navbar | move sidebery's navbar to the top of the sidebar | 114 122 | uc.tweak.no-blur | remove blur and translucency from background of sidebery, navbar, urlbar, etc | 115 - | uc.tweak.translucency | EXPERIMENTAL translucent window background | 123 + | uc.tweak.translucency | experimental translucent window background | 116 124 117 - ### Advanced Configuration 125 + ### advanced configuration 118 126 119 - The variables used by the theme are in `vars.css` and `userChrome.css` (colors). If you would like to ensure there aren't git conflicts you can add a `overrides.css` file in the `chrome` file and override the variables from `vars.css` in there (using `!important;` is necessary). Keep in mind the theme defaults to using `uidensity="compact"`, so you will want to change the variables inside there. 127 + the variables used by the theme are in `vars.css` and `userchrome.css` (colors). if 128 + you would like to ensure there aren't git conflicts you can add a `overrides.css` 129 + file in the `chrome` directory and override the variables from `vars.css` in there (using 130 + `!important;` is necessary). keep in mind the theme defaults to using `uidensity="compact"`, 131 + so you will want to change the variables inside there. 120 132 121 - ## Inspo 133 + ## inspo 122 134 123 - [KiKaraage](https://github.com/KiKaraage/ArcWTF) - ArcWTF 135 + [kikaraage](https://github.com/kikaraage/arcwtf) - arcwtf 124 136 125 - [Shina-SG](https://github.com/Shina-SG/Shina-Fox) - Shina-Fox 137 + [shina-sg](https://github.com/shina-sg/shina-fox) - shina-fox 126 138 127 - [artsyfriedchicken](https://github.com/artsyfriedchicken/EdgyArc-fr) - EdgyArc-fr 139 + [artsyfriedchicken](https://github.com/artsyfriedchicken/edgyarc-fr) - edgyarc-fr 128 140 129 - [Naezer](https://github.com/Naezr/ShyFox) - ShyFox 141 + [naezer](https://github.com/naezr/shyfox) - shyfox 130 142 131 - ## Mirrors 143 + ## mirrors 132 144 133 - Currently potatofox is available on [codeberg](https://codeberg.org/da157/PotatoFox) (main) and [git.gay](https://git.gay/awwpotato/PotatoFox) (backup) 145 + currently potatofox is available on [codeberg](https://codeberg.org/da157/potatofox) (main) and [git.gay](https://git.gay/awwpotato/potatofox) (backup) 134 146 135 - ## License 147 + ## license 136 148 137 - The source code of this project is subject to the terms of the [MPLv2.0](https://www.mozilla.org/en-US/MPL/2.0/) license. 138 - All documentation and images included as part of this README are licensed under [CC BY-SA](https://creativecommons.org/licenses/by-sa/4.0/). 149 + the source code of this project is subject to the terms of the [mplv2.0](https://www.mozilla.org/en-us/mpl/2.0/) license. 150 + all documentation and images included as part of this readme are licensed under [cc by-sa](https://creativecommons.org/licenses/by-sa/4.0/).