Merge pull request #81 from Builditluc/feature/improve-ui

Cargo.toml

@@ -32,6 +32,7 @@ panic-message = "0.3.0"
 backtrace = "0.3"
 toml = "0.5.9"
 structopt = "0.3.25"
+chrono = "0.4"
 
 [dependencies.cursive]
 version = "0.17"
@@ -41,6 +42,9 @@ default-features = false
 # git = "https://github.com/gyscos/cursive_buffered_backend"
 version = "0.6.0"
 
+[dependencies.cursive-aligned-view]
+version = "0.6.0"
+
 [dependencies.reqwest]
 version = "0.11"
 features = ["json", "blocking"]

README.md

@@ -25,8 +25,9 @@
 ## Preview
 ### How it looks
 
-![image](https://user-images.githubusercontent.com/37375448/139769364-46a69dce-f386-4369-a82e-4a45adac3b52.png)
-![image](https://user-images.githubusercontent.com/37375448/139769469-0b2e9f01-f758-4bb2-8227-4186f658cfcc.png) <br>
+![preview-1](docs/assets/images/preview-1.png)
+![preview-2](docs/assets/images/preview-2.png)
+![preview-3](docs/assets/images/preview-3.png)
 > Note: These Screenshots were taken on [iTerm2](https://iterm2.com) (MacOS) with the [Fira Code](https://github.com/tonsky/FiraCode) font
 
 For more information, please visit the [website](https://builditluc.github.io/wiki-tui/)

docs/configuration/keybindings.md

@@ -28,7 +28,7 @@ The following modes are supported
 | Key            | Config Name |
 |----------------|-------------|
  |                | `normal`    |
-| ++shift++      | `shit`      |
+| ++shift++      | `shift`      |
 | ++alt++        | `alt`       |
 | ++alt+shift++  | `altshift`  |
 | ++ctrl++       | `ctrl`      |

docs/configuration/theme.md

@@ -127,5 +127,49 @@ highlight_text = "white"
 text = "black"
 ```
 
+## Configure the borders
+
+:fontawesome-solid-microchip: pre-release
+:octicons-milestone-16: Default: `default` | `thin`
+
+!!! warning
+    Depending on your font, some border styles may differ from the examples below
+
+You can change the look of the borders in wiki-tui. Available styles are:
+
+* `thin` | `default`
+* `heavy`
+* `round`
+
+> The excat unicode characters used for the borders can be found in the following file: `src/ui/panel.rs`
+
+??? example "Thin / Default"
+    ```toml
+    theme.border = "default"
+    ```
+    or
+    ```toml
+    theme.border = "thin"
+    ```
+
+    ![Border-Thin-1](../assets/images/border-thin-1.png)
+    ![Border-Thin-2](../assets/images/border-thin-2.png)
+
+??? example "Heavy"
+    ```toml
+    theme.border = "heavy"
+    ```
+
+    ![Border-Heavy-1](../assets/images/border-heavy-1.png)
+    ![Border-Heavy-2](../assets/images/border-heavy-2.png)
+
+??? example "Round"
+    ```toml
+    theme.border = "round"
+    ```
+
+    ![Border-Round-1](../assets/images/border-round-1.png)
+    ![Border-Round-2](../assets/images/border-round-2.png)
+
 [release-0.3.0]: https://github.com/Builditluc/wiki-tui/releases/tag/v0.3
 [release-0.4.0]: https://github.com/Builditluc/wiki-tui/releases/tag/v0.4

docs/index.md

@@ -26,8 +26,13 @@ A simple and easy to use Wikipedia Text User Interface
 <center>
 ![Preview-1](assets/images/preview-1.png)
 ![Preview-2](assets/images/preview-2.png)
+![Preview-3](assets/images/preview-3.png)
 </center>
 
+??? note "About those Screenshots"
+    They were taken on MacOS (iTerm2) with the gruvbox terminal colorscheme. The only
+    configuration change that was done is setting the borders to round
+
 # What can I do with it?
 
 ## Search

mkdocs.yml

@@ -8,6 +8,7 @@ repo_url: https://github.com/builditluc/wiki-tui
 
 theme:
   name: material
+  custom_dir: overrides
   icon:
     logo: material/console
     repo: fontawesome/brands/github
@@ -18,6 +19,7 @@ theme:
     - navigation.top
     - navigation.sections
     - navigation.indexes
+    - announce.dismiss
   palette:
     - media: "(prefers-color-scheme: light)"
       scheme: default
@@ -40,7 +42,7 @@ nav:
   - Configuration:
     - configuration/index.md
     - Api Settings: configuration/api.md
-    - Changing the Colors: configuration/theme.md
+    - Changing the Theme: configuration/theme.md
     - Configure the Logging: configuration/logging.md
     - Features: configuration/features.md
     - Keybindings: configuration/keybindings.md

overrides/main.html

@@ -0,0 +1,18 @@
+{% extends "base.html" %}
+
+{% block announce %}
+
+v0.6.0 is out now!
+Changes include:
+
+<ul>
+  <li>Multiple border types</li>
+  <li>A better looking default theme</li>
+  <li>Cleaner UI</li>
+  <li>Popup Searchbar (Press Shift+S inside of an article)</li>
+  <li>Auto generation of the configuration file</li>
+</ul>
+
+And more!
+
+{% endblock %}

src/backend.rs

@@ -0,0 +1,37 @@
+use cursive::backends;
+use cursive_buffered_backend::BufferedBackend;
+
+#[cfg(feature = "blt-backend")]
+pub fn backend() -> Box<BufferedBackend> {
+    let blt_backend = backends::blt::Backend::init();
+    let buffered_backend = BufferedBackend::new(blt_backend);
+    Box::new(buffered_backend)
+}
+
+#[cfg(feature = "termion-backend")]
+pub fn backend() -> Box<BufferedBackend> {
+    let termion_backend = backends::termion::Backend::init().unwrap();
+    let buffered_backend = BufferedBackend::new(termion_backend);
+    Box::new(buffered_backend)
+}
+
+#[cfg(feature = "crossterm-backend")]
+pub fn backend() -> Box<BufferedBackend> {
+    let crossterm_backend = backends::crossterm::Backend::init().unwrap();
+    let buffered_backend = BufferedBackend::new(crossterm_backend);
+    Box::new(buffered_backend)
+}
+
+#[cfg(feature = "pancurses-backend")]
+pub fn backend() -> Box<BufferedBackend> {
+    let pancurses_backend = backends::curses::pan::Backend::init().unwrap();
+    let buffered_backend = BufferedBackend::new(pancurses_backend);
+    Box::new(buffered_backend)
+}
+
+#[cfg(feature = "ncurses-backend")]
+pub fn backend() -> Box<BufferedBackend> {
+    let ncurses_backend = backends::curses::n::Backend::init().unwrap();
+    let buffered_backend = BufferedBackend::new(ncurses_backend);
+    Box::new(buffered_backend)
+}