0
0
mirror of https://github.com/neon-mmd/websurfx.git synced 2024-12-22 20:38:22 -05:00

Merge pull request #151 from neon-mmd/readme-revision

📜 Revise the `docs` to remain in sync with the current changes
This commit is contained in:
zhou fan 2023-07-19 17:03:47 +08:00 committed by GitHub
commit 9964be472e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 433 additions and 171 deletions

168
Cargo.lock generated
View File

@ -66,7 +66,7 @@ dependencies = [
"http 0.2.9",
"httparse",
"httpdate",
"itoa 1.0.8",
"itoa 1.0.9",
"language-tags",
"local-channel",
"mime",
@ -87,7 +87,7 @@ version = "0.2.3"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "465a6172cf69b960917811022d8f29bc0b7fa1398bc4f78b3c466673db1213b6"
dependencies = [
"quote 1.0.29",
"quote 1.0.31",
"syn 1.0.109",
]
@ -178,7 +178,7 @@ dependencies = [
"futures-core",
"futures-util",
"http 0.2.9",
"itoa 1.0.8",
"itoa 1.0.9",
"language-tags",
"log",
"mime",
@ -201,8 +201,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2262160a7ae29e3415554a3f1fc04c764b1540c116aa524683208078b7a75bc9"
dependencies = [
"actix-router",
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"syn 1.0.109",
]
@ -282,9 +282,9 @@ checksum = "3a30da5c5f2d5e72842e00bcb57657162cdabef0931f40e2deb9b4140440cecd"
[[package]]
name = "anyhow"
version = "1.0.71"
version = "1.0.72"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9c7d0618f0e0b7e8ff11427422b64564d5fb0be1940354bfe2e0529b18a9d9b8"
checksum = "3b13c32d80ecc7ab747b80c3784bce54ee8a7a0cc4fbda9bf4cda2cf6fe90854"
[[package]]
name = "askama_escape"
@ -298,8 +298,8 @@ version = "0.1.71"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a564d521dd56509c4c47480d00b80ee55f7e385ae48db5744c67ad50c92d2ebf"
dependencies = [
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"syn 2.0.26",
]
@ -517,18 +517,18 @@ dependencies = [
[[package]]
name = "clap"
version = "4.3.12"
version = "4.3.15"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3eab9e8ceb9afdade1ab3f0fd8dbce5b1b2f468ad653baf10e771781b2b67b73"
checksum = "8f644d0dac522c8b05ddc39aaaccc5b136d5dc4ff216610c5641e3be5becf56c"
dependencies = [
"clap_builder",
]
[[package]]
name = "clap_builder"
version = "4.3.12"
version = "4.3.15"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "9f2763db829349bf00cfc06251268865ed4363b93a943174f638daf3ecdba2cd"
checksum = "af410122b9778e024f9e0fb35682cc09cc3f85cad5e8d3ba8f47a9702df6e73d"
dependencies = [
"anstyle",
"clap_lex",
@ -783,7 +783,7 @@ checksum = "5b3df4f93e5fbbe73ec01ec8d3f68bba73107993a5b1e7519273c32db9b0d5be"
dependencies = [
"cssparser-macros",
"dtoa-short",
"itoa 1.0.8",
"itoa 1.0.9",
"phf 0.11.2",
"smallvec 1.11.0",
]
@ -794,7 +794,7 @@ version = "0.6.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "13b588ba4ac1a99f7f2964d24b3d896ddc6bf847ee3855dbd4366f058cfcd331"
dependencies = [
"quote 1.0.29",
"quote 1.0.31",
"syn 2.0.26",
]
@ -805,8 +805,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "4fb810d30a7c1953f91334de7244731fc3f3c10d7fe163338a35b9f640960321"
dependencies = [
"convert_case",
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"rustc_version 0.4.0",
"syn 1.0.109",
]
@ -829,9 +829,9 @@ checksum = "56899898ce76aaf4a0f24d914c97ea6ed976d42fec6ad33fcbb0a1103e07b2b0"
[[package]]
name = "dtoa"
version = "1.0.8"
version = "1.0.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "519b83cd10f5f6e969625a409f735182bea5558cd8b64c655806ceaae36f1999"
checksum = "dcbb2bf8e87535c23f7a8a321e364ce21462d0ff10cb6407820e8e96dfff6653"
[[package]]
name = "dtoa-short"
@ -839,7 +839,7 @@ version = "0.3.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "dbaceec3c6e4211c79e7b1800fb9680527106beb2f9c51904a3210c03a448c74"
dependencies = [
"dtoa 1.0.8",
"dtoa 1.0.9",
]
[[package]]
@ -933,8 +933,8 @@ version = "0.1.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "aa4da3c766cd7a0db8242e326e9e4e081edd567072893ed320008189715366a4"
dependencies = [
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"syn 1.0.109",
"synstructure",
]
@ -1230,8 +1230,8 @@ dependencies = [
"log",
"mac",
"markup5ever 0.11.0",
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"syn 1.0.109",
]
@ -1254,7 +1254,7 @@ checksum = "bd6effc99afb63425aff9b05836f029929e345a6148a14b7ecd5ab67af944482"
dependencies = [
"bytes 1.4.0",
"fnv",
"itoa 1.0.8",
"itoa 1.0.9",
]
[[package]]
@ -1349,7 +1349,7 @@ dependencies = [
"http-body 0.4.5",
"httparse",
"httpdate",
"itoa 1.0.8",
"itoa 1.0.9",
"pin-project-lite",
"socket2",
"tokio 1.29.1",
@ -1489,9 +1489,9 @@ checksum = "b71991ff56294aa922b450139ee08b3bfc70982c6b2c7562771375cf73542dd4"
[[package]]
name = "itoa"
version = "1.0.8"
version = "1.0.9"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "62b02a5381cc465bd3041d84623d0fa3b66738b52b8e2fc3bab8ad63ab032f4a"
checksum = "af150ab688ff2122fcef229be89cb50dd66af9e01a4ff320cc137eecc9bacc38"
[[package]]
name = "jobserver"
@ -1843,8 +1843,8 @@ version = "0.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a948666b637a0f465e8564c73e89d4dde00d72d4d473cc972f390fc3dcee7d9c"
dependencies = [
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"syn 2.0.26",
]
@ -1917,9 +1917,9 @@ dependencies = [
[[package]]
name = "paste"
version = "1.0.13"
version = "1.0.14"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b4b27ab7be369122c218afc2079489cdcb4b517c0a3fc386ff11e1fedfcc2b35"
checksum = "de3145af08024dea9fa9914f381a17b8fc6034dfb00f3a84013f7ff43f29ed4c"
[[package]]
name = "percent-encoding"
@ -1935,9 +1935,9 @@ checksum = "9b2a4787296e9989611394c33f193f676704af1686e70b8f8033ab5ba9a35a94"
[[package]]
name = "pest"
version = "2.7.0"
version = "2.7.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f73935e4d55e2abf7f130186537b19e7a4abc886a0252380b59248af473a3fc9"
checksum = "0d2d1d55045829d65aad9d389139882ad623b33b904e7c9f1b10c5b8927298e5"
dependencies = [
"thiserror",
"ucd-trie",
@ -1945,9 +1945,9 @@ dependencies = [
[[package]]
name = "pest_derive"
version = "2.7.0"
version = "2.7.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "aef623c9bbfa0eedf5a0efba11a5ee83209c326653ca31ff019bec3a95bfff2b"
checksum = "5f94bca7e7a599d89dea5dfa309e217e7906c3c007fb9c3299c40b10d6a315d3"
dependencies = [
"pest",
"pest_generator",
@ -1955,22 +1955,22 @@ dependencies = [
[[package]]
name = "pest_generator"
version = "2.7.0"
version = "2.7.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b3e8cba4ec22bada7fc55ffe51e2deb6a0e0db2d0b7ab0b103acc80d2510c190"
checksum = "99d490fe7e8556575ff6911e45567ab95e71617f43781e5c05490dc8d75c965c"
dependencies = [
"pest",
"pest_meta",
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"syn 2.0.26",
]
[[package]]
name = "pest_meta"
version = "2.7.0"
version = "2.7.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a01f71cb40bd8bb94232df14b946909e14660e33fc05db3e50ae2a82d7ea0ca0"
checksum = "2674c66ebb4b4d9036012091b537aae5878970d6999f81a265034d85b136b341"
dependencies = [
"once_cell",
"pest",
@ -2063,8 +2063,8 @@ checksum = "3444646e286606587e49f3bcf1679b8cef1dc2c5ecc29ddacaffc305180d464b"
dependencies = [
"phf_generator 0.11.2",
"phf_shared 0.11.2",
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"syn 2.0.26",
]
@ -2164,9 +2164,9 @@ dependencies = [
[[package]]
name = "proc-macro2"
version = "1.0.64"
version = "1.0.66"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "78803b62cbf1f46fde80d7c0e803111524b9877184cfe7c3033659490ac7a7da"
checksum = "18fb31db3f9bddb2ea821cde30a9f70117e3f119938b5ee630b7403aa6e2ead9"
dependencies = [
"unicode-ident",
]
@ -2192,11 +2192,11 @@ dependencies = [
[[package]]
name = "quote"
version = "1.0.29"
version = "1.0.31"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "573015e8ab27661678357f27dc26460738fd2b6c86e46f386fde94cb5d913105"
checksum = "5fe8a65d69dd0808184ebb5f836ab526bb259db23c657efa38711b1072ee47f0"
dependencies = [
"proc-macro2 1.0.64",
"proc-macro2 1.0.66",
]
[[package]]
@ -2373,7 +2373,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "3ea8c51b5dc1d8e5fd3350ec8167f464ec0995e79f2e90a075b63371500d557f"
dependencies = [
"combine",
"itoa 1.0.8",
"itoa 1.0.9",
"percent-encoding 2.3.0",
"ryu",
"sha1_smol",
@ -2540,7 +2540,7 @@ version = "0.4.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bfa0f585226d2e68097d4f95d113b15b83a82e819ab25717ec0590d9584ef366"
dependencies = [
"semver 1.0.17",
"semver 1.0.18",
]
[[package]]
@ -2584,9 +2584,9 @@ dependencies = [
[[package]]
name = "ryu"
version = "1.0.14"
version = "1.0.15"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "fe232bdf6be8c8de797b22184ee71118d63780ea42ac85b61d1baa6d3b782ae9"
checksum = "1ad4cc8da4ef723ed60bced201181d83791ad433213d8c24efffda1eec85d741"
[[package]]
name = "same-file"
@ -2608,9 +2608,9 @@ dependencies = [
[[package]]
name = "scopeguard"
version = "1.1.0"
version = "1.2.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d29ab0c6d3fc0ee92fe66e2d99f700eab17a8d57d1c1d3b748380fb20baa78cd"
checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49"
[[package]]
name = "scraper"
@ -2692,9 +2692,9 @@ dependencies = [
[[package]]
name = "semver"
version = "1.0.17"
version = "1.0.18"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bebd363326d05ec3e2f532ab7660680f3b02130d780c299bca73469d521bc0ed"
checksum = "b0293b4b29daaf487284529cc2f5675b8e57c61f70167ba415a463651fd6a918"
[[package]]
name = "semver-parser"
@ -2717,18 +2717,18 @@ version = "1.0.171"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "389894603bd18c46fa56231694f8d827779c0951a667087194cf9de94ed24682"
dependencies = [
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"syn 2.0.26",
]
[[package]]
name = "serde_json"
version = "1.0.102"
version = "1.0.103"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b5062a995d481b2308b6064e9af76011f2921c35f97b0468811ed9f6cd91dfed"
checksum = "d03b412469450d4404fe8499a268edd7f8b79fecb074b0d812ad64ca21f4031b"
dependencies = [
"itoa 1.0.8",
"itoa 1.0.9",
"ryu",
"serde",
]
@ -2752,7 +2752,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "d3491c14715ca2294c4d6a88f15e84739788c1d030eed8c110436aafdaa2f3fd"
dependencies = [
"form_urlencoded",
"itoa 1.0.8",
"itoa 1.0.9",
"ryu",
"serde",
]
@ -2901,8 +2901,8 @@ checksum = "f0f45ed1b65bf9a4bf2f7b7dc59212d1926e9eaf00fa998988e420fd124467c6"
dependencies = [
"phf_generator 0.7.24",
"phf_shared 0.7.24",
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"string_cache_shared",
]
@ -2914,8 +2914,8 @@ checksum = "6bb30289b722be4ff74a408c3cc27edeaad656e06cb1fe8fa9231fa59c728988"
dependencies = [
"phf_generator 0.10.0",
"phf_shared 0.10.0",
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
]
[[package]]
@ -2941,8 +2941,8 @@ version = "1.0.109"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237"
dependencies = [
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"unicode-ident",
]
@ -2952,8 +2952,8 @@ version = "2.0.26"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "45c3457aacde3c65315de5031ec191ce46604304d2446e803d71ade03308d970"
dependencies = [
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"unicode-ident",
]
@ -2963,8 +2963,8 @@ version = "0.12.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f36bdaa60a83aca3921b5259d5400cbf5e90fc51931376a9bd4a0eb79aa7210f"
dependencies = [
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"syn 1.0.109",
"unicode-xid 0.2.4",
]
@ -3018,8 +3018,8 @@ version = "1.0.43"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "463fe12d7993d3b327787537ce8dd4dfa058de32fc2b195ef3cde03dc4771e8f"
dependencies = [
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"syn 2.0.26",
]
@ -3040,7 +3040,7 @@ version = "0.3.23"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "59e399c068f43a5d116fedaf73b203fa4f9c519f17e2b34f63221d3792f81446"
dependencies = [
"itoa 1.0.8",
"itoa 1.0.9",
"serde",
"time-core",
"time-macros",
@ -3173,8 +3173,8 @@ version = "2.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "630bdcf245f78637c13ec01ffae6187cca34625e8c63150d424b59e55af2675e"
dependencies = [
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"syn 2.0.26",
]
@ -3495,8 +3495,8 @@ dependencies = [
"bumpalo",
"log",
"once_cell",
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"syn 2.0.26",
"wasm-bindgen-shared",
]
@ -3519,7 +3519,7 @@ version = "0.2.87"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "dee495e55982a3bd48105a7b947fd2a9b4a8ae3010041b9e0faab3f9cd028f1d"
dependencies = [
"quote 1.0.29",
"quote 1.0.31",
"wasm-bindgen-macro-support",
]
@ -3529,8 +3529,8 @@ version = "0.2.87"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "54681b18a46765f095758388f2d0cf16eb8d4169b639ab575a8f5693af210c7b"
dependencies = [
"proc-macro2 1.0.64",
"quote 1.0.29",
"proc-macro2 1.0.66",
"quote 1.0.31",
"syn 2.0.26",
"wasm-bindgen-backend",
"wasm-bindgen-shared",
@ -3554,7 +3554,7 @@ dependencies = [
[[package]]
name = "websurfx"
version = "0.14.0"
version = "0.14.1"
dependencies = [
"actix-files",
"actix-web",

View File

@ -1,6 +1,6 @@
[package]
name = "websurfx"
version = "0.14.0"
version = "0.14.1"
edition = "2021"
description = "An open-source alternative to Searx that provides clean, ad-free, and organic results with incredible speed while keeping privacy and security in mind."
repository = "https://github.com/neon-mmd/websurfx"

View File

@ -17,6 +17,7 @@ Some of the configuration options provided in the file are stated below. These a
- Server
- Website
- Cache
- Search Engines
# General
@ -33,17 +34,20 @@ Some of the configuration options provided in the file are stated below. These a
- **colorscheme:** The colorscheme name which should be used for the website theme (the name should be in accordance to the colorscheme file name present in `public/static/colorschemes` folder).
> By Default we provide 9 colorschemes to choose from these are:
> By Default we provide 12 colorschemes to choose from these are:
>
> 1. catppuccin-mocha
> 2. dracula
> 3. monokai
> 4. nord
> 5. oceanic-next
> 6. solarized-dark
> 7. solarized-light
> 8. tomorrow-night
> 9. gruvbox-dark
> 2. dark-chocolate
> 3. dracula
> 4. gruvbox-dark
> 5. monokai
> 6. nord
> 7. oceanic-next
> 8. one-dark
> 9. solarized-dark
> 10. solarized-light
> 11. tokyo-night
> 12. tomorrow-night
- **theme:** The theme name which should be used for the website (again, the name should be in accordance to the theme file name present in `public/static/themes` folder).
@ -53,6 +57,10 @@ Some of the configuration options provided in the file are stated below. These a
## Cache
- **redis_connection_url:** Redis connection url address on which the client should connect on.
- **redis_url:** Redis connection url address on which the client should connect on.
[⬅️ Go back to Home](./README.md)
## Search Engines
- **upstream_search_engines:** Select from the different upstream search engines from which the results should be fetched.
[⬅️ Go back to Home](./README.md)

View File

@ -10,7 +10,7 @@ paru -S websurfx-edge-git
After installing it you can run the websurfx server by running the following commands:
``` bash
```bash
redis-server --port 8082 &
websurfx
```
@ -19,7 +19,7 @@ Once you have started the server, open your preferred web browser and navigate t
If you want to change the port or the ip or any other configuration setting checkout the [configuration docs](./configuration.md).
## Other Distros
## Other Distros
The package is currently not available on other Linux distros. With contribution and support it can be made available on other distros as well 🙂.
@ -91,12 +91,16 @@ production_use = false -- whether to use production mode or not (in other words
-- The different colorschemes provided are:
-- {{
-- catppuccin-mocha
-- dark-chocolate
-- dracula
-- gruvbox-dark
-- monokai
-- nord
-- oceanic-next
-- one-dark
-- solarized-dark
-- solarized-light
-- tokyo-night
-- tomorrow-night
-- }}
colorscheme = "catppuccin-mocha" -- the colorscheme name which should be used for the website theme
@ -104,6 +108,9 @@ theme = "simple" -- the theme name which should be used for the website
-- ### Caching ###
redis_connection_url = "redis://redis:6379" -- redis connection url address on which the client should connect on.
-- ### Search Engines ###
upstream_search_engines = { DuckDuckGo = true, Searx = false } -- select the upstream search engines from which the results should be fetched.
```
After this run the following command to deploy the app:
@ -124,4 +131,4 @@ cd websurfx
git checkout stable
```
[⬅️ Go back to Home](./README.md)
[⬅️ Go back to Home](./README.md)

View File

@ -8,17 +8,17 @@ By default `websurfx` comes with 9 colorschemes to choose from which can be easi
Creating coloschemes is as easy as it gets it requires the user to have a theme file name with the colorscheme in which every space should be replaced with a `-` (dash) and it should end with a `.css` file extension. After creating the file you need to add the following code with the `colors` you want:
``` css
:root{
--bg: <background color>;
--fg: <foreground color (text color)>;
--1: <color 1>;
--2: <color 2>;
--3: <color 3>;
--4: <color 4>;
--5: <color 5>;
--6: <color 6>;
--7: <color 7>;
```css
:root {
--background-color: <background color>;
--foreground-color: <foreground color (text color on the website) >;
--color-one: <color 1>;
--color-two: <color 2>;
--color-three: <color 3>;
--color-four: <color 4>;
--color-five: <color 5>;
--color-six: <color 6>;
--color-seven: <color 7>;
}
```
@ -27,17 +27,17 @@ Creating coloschemes is as easy as it gets it requires the user to have a theme
**Example of `catppuccin-mocha` colorscheme:**
``` css
```css
:root {
--bg: #1e1e2e;
--fg: #cdd6f4;
--1: #45475a;
--2: #f38ba8;
--3: #a6e3a1;
--4: #f9e2af;
--5: #89b4fa;
--6: #f5c2e7;
--7: #ffffff;
--background-color: #1e1e2e;
--foreground-color: #cdd6f4;
--color-one: #45475a;
--color-two: #f38ba8;
--color-three: #a6e3a1;
--color-four: #f9e2af;
--color-five: #89b4fa;
--color-six: #f5c2e7;
--color-seven: #ffffff;
}
```
@ -47,14 +47,15 @@ Creating coloschemes is as easy as it gets it requires the user to have a theme
By default `websurfx` comes with 1 theme to choose from which can be easily chosen using the config file. To how to change themes please view the [Configuration](https://github.com/neon-mmd/websurfx/wiki/configuration) section of the wiki.
## Custom
## Custom
To write custom color scheme, it requires the user to have some knowledge of `css stylesheets`.
To write custom color scheme, it requires the user to have some knowledge of `css stylesheets`.
**Here is an example of `simple theme` (which we provide by default with the app) which will give the user a better idea on how to create a custom theme using it as a template:**
### General
``` css
```css
* {
padding: 0;
margin: 0;
@ -71,11 +72,13 @@ body {
justify-content: space-between;
align-items: center;
height: 100vh;
background: var(--1);
background: var(--color-one);
}
```
### Styles for the index page
``` css
```css
.search-container {
display: flex;
flex-direction: column;
@ -88,8 +91,10 @@ body {
display: flex;
}
```
### Styles for the search box and search button
``` css
```css
.search_bar {
display: flex;
}
@ -101,7 +106,7 @@ body {
outline: none;
border: none;
box-shadow: rgba(0, 0, 0, 1);
background: var(--fg);
background: var(--foreground-color);
}
.search_bar button {
@ -114,8 +119,8 @@ body {
outline: none;
border: none;
gap: 0;
background: var(--bg);
color: var(--3);
background: var(--background-color);
color: var(--color-three);
font-weight: 600;
letter-spacing: 0.1rem;
}
@ -125,10 +130,12 @@ body {
filter: brightness(1.2);
}
```
### Styles for the footer and header
``` css
```css
header {
background: var(--bg);
background: var(--background-color);
width: 100%;
display: flex;
justify-content: right;
@ -151,7 +158,7 @@ footer ul li a,
header ul li a:visited,
footer ul li a:visited {
text-decoration: none;
color: var(--2);
color: var(--color-two);
text-transform: capitalize;
letter-spacing: 0.1rem;
}
@ -162,7 +169,27 @@ header ul li a {
header ul li a:hover,
footer ul li a:hover {
color: var(--5);
color: var(--color-five);
}
footer div span {
font-size: 1.5rem;
color: var(--color-four);
}
footer div {
display: flex;
gap: 1rem;
}
footer {
background: var(--background-color);
width: 100%;
padding: 1rem;
display: flex;
flex-direction: column;
justify-content: center;
align-items: center;
}
footer div span {
@ -185,8 +212,10 @@ footer {
align-items: center;
}
```
### Styles for the search page
``` css
```css
.results {
width: 90%;
display: flex;
@ -213,28 +242,28 @@ footer {
.results_aggregated .result h1 a {
font-size: 1.5rem;
color: var(--2);
color: var(--color-two);
text-decoration: none;
letter-spacing: 0.1rem;
}
.results_aggregated .result h1 a:hover {
color: var(--5);
color: var(--color-five);
}
.results_aggregated .result h1 a:visited {
color: var(--bg);
color: var(--background-color);
}
.results_aggregated .result small {
color: var(--3);
color: var(--color-three);
font-size: 1.1rem;
word-wrap: break-word;
line-break: anywhere;
}
.results_aggregated .result p {
color: var(--fg);
color: var(--foreground-color);
font-size: 1.2rem;
margin-top: 0.3rem;
word-wrap: break-word;
@ -245,13 +274,13 @@ footer {
text-align: right;
font-size: 1.2rem;
padding: 1rem;
color: var(--5);
color: var(--color-five);
}
```
### Styles for the 404 page
### Styles for the 404 page
``` css
```css
.error_container {
display: flex;
justify-content: center;
@ -290,16 +319,18 @@ footer {
.error_content p a,
.error_content p a:visited {
color: var(--2);
color: var(--color-two);
text-decoration: none;
}
.error_content p a:hover {
color: var(--5);
color: var(--color-five);
}
```
### Styles for the previous and next button on the search page
``` css
```css
.page_navigation {
padding: 0 0 2rem 0;
display: flex;
@ -308,8 +339,8 @@ footer {
}
.page_navigation button {
background: var(--bg);
color: var(--fg);
background: var(--background-color);
color: var(--foreground-color);
padding: 1rem;
border-radius: 0.5rem;
outline: none;
@ -326,40 +357,256 @@ footer {
This part is only available right now in the **rolling/edge/unstable** version
```css
.about-container article{
font-size: 1.5rem;
color:var(--fg);
padding-bottom: 10px;
}
.about-container article h1{
color: var(--2);
font-size: 2.8rem;
}
.about-container article div{
padding-bottom: 15px;
}
.about-container a{
color:var(--3);
.about-container article {
font-size: 1.5rem;
color: var(--foreground-color);
padding-bottom: 10px;
}
.about-container article h2{
color: var(--3);
.about-container article h1 {
color: var(--color-two);
font-size: 2.8rem;
}
.about-container article div {
padding-bottom: 15px;
}
.about-container a {
color: var(--color-three);
}
.about-container article h2 {
color: var(--color-three);
font-size: 1.8rem;
padding-bottom: 10px;
}
.about-container p{
color:var(--fg);
font-size: 1.6rem;
.about-container p {
color: var(--foreground-color);
font-size: 1.6rem;
padding-bottom: 10px;
}
.about-container h3{
.about-container h3 {
font-size: 1.5rem;
}
.about-container {
width: 80%;
}
```
[⬅️ Go back to Home](./README.md)
### Styles for the Settings Page
This part is only available right now in the **rolling/edge/unstable** version
```css
.settings_container {
display: flex;
justify-content: space-around;
width: 80dvw;
}
.settings h1 {
color: var(--color-two);
font-size: 2.5rem;
}
.settings hr {
border-color: var(--color-three);
margin: 0.3rem 0 1rem 0;
}
.settings_container .sidebar {
width: 30%;
cursor: pointer;
font-size: 2rem;
display: flex;
flex-direction: column;
margin-right: 0.5rem;
margin-left: -0.7rem;
padding: 0.7rem;
border-radius: 5px;
font-weight: bold;
margin-bottom: 0.5rem;
color: var(--foreground-color);
text-transform: capitalize;
gap: 1.5rem;
}
.settings_container .sidebar .btn {
padding: 0.5rem;
border-radius: 0.5rem;
}
.settings_container .sidebar .btn.active {
background-color: var(--color-two);
}
.settings_container .main_container {
width: 70%;
border-left: 1.5px solid var(--color-three);
padding-left: 3rem;
}
.settings_container .tab {
display: none;
}
.settings_container .tab.active {
display: flex;
flex-direction: column;
justify-content: space-around;
}
.settings_container button {
margin-top: 1rem;
padding: 1rem 2rem;
font-size: 1.5rem;
background: var(--color-three);
color: var(--background-color);
border-radius: 0.5rem;
border: 2px solid transparent;
font-weight: bold;
transition: all 0.1s ease-out;
cursor: pointer;
box-shadow: 5px 5px;
outline: none;
}
.settings_container button:active {
box-shadow: none;
translate: 5px 5px;
}
.settings_container .main_container .message {
font-size: 1.5rem;
color: var(--foreground-color);
}
.settings_container .tab h3 {
font-size: 2rem;
font-weight: bold;
color: var(--color-four);
margin-top: 1.5rem;
text-transform: capitalize;
}
.settings_container .tab .description {
font-size: 1.5rem;
margin-bottom: 0.5rem;
color: var(--foreground-color);
}
.settings_container .user_interface select {
margin: 0.7rem 0;
width: 20rem;
background-color: var(--background-color);
color: var(--foreground-color);
padding: 1rem 2rem;
border-radius: 0.5rem;
outline: none;
border: none;
text-transform: capitalize;
}
.settings_container .user_interface option:hover {
background-color: var(--color-one);
}
.settings_container .engines .engine_selection {
display: flex;
flex-direction: column;
justify-content: center;
gap: 1rem;
padding: 1rem 0;
}
.settings_container .engines .toggle_btn {
color: var(--foreground-color);
font-size: 1.5rem;
display: flex;
gap: 0.5rem;
align-items: center;
}
.settings_container .engines hr {
margin: 0;
}
.settings_container .cookies input {
margin: 1rem 0rem;
}
```
### Styles for the Toggle Button
This part is only available right now in the **rolling/edge/unstable** version
```css
/* The switch - the box around the slider */
.switch {
position: relative;
display: inline-block;
width: 6rem;
height: 3.4rem;
}
/* Hide default HTML checkbox */
.switch input {
opacity: 0;
width: 0;
height: 0;
}
/* The slider */
.slider {
position: absolute;
cursor: pointer;
top: 0;
left: 0;
right: 0;
bottom: 0;
background-color: var(--background-color);
-webkit-transition: 0.4s;
transition: 0.4s;
}
.slider:before {
position: absolute;
content: '';
height: 2.6rem;
width: 2.6rem;
left: 0.4rem;
bottom: 0.4rem;
background-color: var(--foreground-color);
-webkit-transition: 0.4s;
transition: 0.4s;
}
input:checked + .slider {
background-color: var(--color-three);
}
input:focus + .slider {
box-shadow: 0 0 1px var(--color-three);
}
input:checked + .slider:before {
-webkit-transform: translateX(2.6rem);
-ms-transform: translateX(2.6rem);
transform: translateX(2.6rem);
}
/* Rounded sliders */
.slider.round {
border-radius: 3.4rem;
}
.slider.round:before {
border-radius: 50%;
}
```
[⬅️ Go back to Home](./README.md)