Update docs and README for --print-config.

Clean up the README and add suitable links(to the webpage)

Author: kajuburfi

README.md

@@ -7,11 +7,20 @@
 Many similar tools exist, but this was sort of a learning project(for rust), and 
 none of them met all the requirements I was looking for in a `jrnl`-ing system.
 
+## Visit the Webpage
+
+Visit the relevant webpage [here](https://kajuburfi.github.io/jrnl/) to view the 
+- [Video Demo](https://kajuburfi.github.io/jrnl/#videoDemo) in case it doesn't work here.
+- [Features](https://kajuburfi.github.io/jrnl/#features) in detail.
+- [Usage](https://kajuburfi.github.io/jrnl/#usage), on how to properly use it(in detail).
+
 ## Demo
+> Visit the website [here](https://kajuburfi.github.io/jrnl/#videoDemo) in case it doesn't work here.
 
 https://github.com/user-attachments/assets/ed63f1c8-8ef2-4dc6-a1a4-02f20681abbe
 
 ## Features(in brief)
+> Visit the [webpage](https://kajuburfi.github.io/jrnl/#features) to see the detailed features.
 
 - All data is stored in markdown format(so **nothing** is _encrypted_).
 - You can have multiple different `jrnl_folder`s, for different purposes, and can use any one from any
@@ -38,90 +47,6 @@ cargo install --git https://github.com/kajuburfi/jrnl --locked
 
 > Note: This is meant for my personal use, and so many things are hardcoded. Use at your own risk. 
 
-## Features
-- Arranges entries of each day such that a month of entries is stored in a file. 
-  File structure(tree):
-  ```
-  Template           |   Example
-                     |
-  jrnl_folder        |   jrnl_folder
-  '- YYYY            |   '- 2025
-  |  '- YYYY_MM.md   |   |  '- 2025_01.md
-  |  '- YYYY_MM.md   |   |  '- 2025_02.md
-  '- YYYY            |   '- 2026
-  |  '- YYYY_MM.md   |   |  '- 2026_01.md
-  |  '- YYYY_MM.md   |   |  '- 2026_02.md
-  ```
-- Just by running `jrnl` with no flags opens the current day's entry in your text editor.
-  Automatically fills in the date - weekday and time is configurable.
-- General entry format:
-  ```
-  Template                |   Example
-  ### WEEKDAY (HH:MM:SS)  |   ### FRI (13:05:28)
-  # YYYY-MM-DD            |   # 2025-03-28
-  - [tag] entry           |   - [milestone] [game] Played and won 200th game of chess.
-  - entry                 |   - Cleaned up room.
-  - [tag1] [tag2] entry   |   - [fees] Paid electricity bill.
-  ```
-- All entries are in standard markdown, for ease of reading.
-- Entries of any date can be fetched and pretty-printed to the terminal.
-- Any given entry can be opened with the text editor at that date, in case of any editing required.
-- Tags are implemented; one can search for all occurances of a tag in a given month or year.
-  When searched for, a table is printed, with the dates and respective entries that contain
-  the given tag. The tag is highlighted. Further, a calendar of the current month(or months - if in a year)
-  is printed, with the dates of the tags used being highlighted.
-  ```
-  ╭───────────────┬──────────────────────────────────────────╮
-  │ Date of Entry ┆ Record                                   │
-  ╞═══════════════╪══════════════════════════════════════════╡
-  │ 2025-03-31    ┆ [tag_1] Stuff                            │
-  ├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
-  │ 2025-03-29    ┆ [tag_1] Some more                        │ 
-  ├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
-  │ 2025-03-28    ┆ [tag_1] Other things                     │
-  ╰───────────────┴──────────────────────────────────────────╯
-       March 2025
-  Mo Tu We Th Fr Sa Su
-                  1  2
-   3  4  5  6  7  8  9
-  10 11 12 13 14 15 16
-  17 18 19 20 21 22 23
-  24 25 26 27 28 29 30
-  31
-  ```
-  (Note: Here, the colors cannot be shown, so you'll have to trust this.)
-- A special tag - `food` is pre-defined. Input your daily food intake as:
-  ```
-  - [food] Breakfast | Lunch | Dinner | Other
-  <!-- Example -->
-  - [food] some breakfast item | A lunch item - course 1 A lunch item - course 2 A lunch item - course 3 | A filling dinner. A tasty dinner. | Snack - Chips Fruit - Mango
-  ```
-  When fetching the tag through `--tag food`, you get a nice ascii table(along with a calendar - not shown here):
-  ```
-  ╭───────────────┬─────────────────────┬─────────────────────────┬───────────────────┬────────────────╮
-  │ Date of Entry ┆ Breakfast           ┆ Lunch                   ┆ Dinner            ┆ Other          │
-  ╞═══════════════╪═════════════════════╪═════════════════════════╪═══════════════════╪════════════════╡
-  │ 2025-03-27    ┆ some breakfast item ┆ A lunch item - course 1 ┆ A filling dinner. ┆ Snack - Chips  │
-  │               ┆                     ┆ A lunch item - course 2 ┆ A tasty dinner.   ┆ Fruit - Mango  │
-  │               ┆                     ┆ A lunch item - course 3 ┆                   ┆                │
-  ╰───────────────┴─────────────────────┴─────────────────────────┴───────────────────┴────────────────╯
-  ```
-- If there are too many entries for a tag or for the food tag(specifically), it will automatically open
-  a pager with the contents(configurable). 
-- To fetch entries(or open them), a date is required. You can either pass this through the flag `--entry YYYY-MM-DD`
-  (`-e YYYY-MM-DD`), or if you just pass an empty flag(`-e`), an interactive calendar will prompt for the 
-  date(Using [inquire](https://github.com/mikaelmello/inquire)). The calendar will also open if there is any 
-  problem with reading the date.
-- When fetching tags, the default file to search for is the current month's file. However, you can specify any other 
-  file using `--year YYYY`(`-y YYYY`) or `--month MM`(`-m MM`). If only provided with a year, and no month, all files
-  of that year will be searched through and printed chronologically.(The pager comes in use here)
-- A feature of "generating reports" is implemented. Currently, it goes through a file, and prints the number of entries
-  of that month, and the most used tags. Similar to tags, you can specify the month and/or year to get a specific month's
-  report.
-- All tables are automatically wrapped around if its width exceeds 90% of the terminal width.
-- Calendars are printed in tags and generating reports, with highlighting. 
-  The calendars of each month will be printed in a grid-like form, extending rightwards depending
-  on your terminal's width. 
 
 ## Configuration
 

docs/index.html

@@ -40,7 +40,7 @@ <h1 id="videoDemo"> Video Demo </h1>
   <p> A sample video showing most of the functionalities of this tool with a dummy input </p>
   <video width=100% height=100% controls> <source src="video.mp4" type="video/mp4"> </video>
 
-  <h1> Features </h1>
+  <h1 id="features"> Features </h1>
   <ul>
   <li>Arranges entries of each day such that a month of entries is stored in a file. 
     File structure(tree):
@@ -132,7 +132,7 @@ <h1> Features </h1>
     on your terminal's width. </li>
   </ul>
 
-  <h1> Usage </h1>
+  <h1 id="usage"> Usage </h1>
   <p> This is a quite detailed explanation of what I made this tool for and how to use it to get the most out of it </p>
   <p> Once <a href="https://github.com/kajuburfi/jrnl/tree/master?tab=readme-ov-file#installation">installed</a>, run <code>jrnl -V</code>. You should get the version printed out. </p>
 
@@ -246,6 +246,47 @@ <h2><code>--path</code> or <code>-p</code></h2>
   Here, if you provide the <i>"path"</i>, it will use that. If you don't, it will search for <code>jrnl_folder</code> in 
   the current directory.
 
+  <h2><code>--print-config</code></h2>
+  This prints the current configuration in a nice table format.
+  Sample output, for the default config:(Colors can't be shown)
+  <pre><code class="lang-plaintext">CONFIGURATION
+╭──────────────────────────────┬─────────╮
+│ Quantities                   ┆ Value   │
+╞══════════════════════════════╪═════════╡
+│ Add Weekday                  ┆ true    │
+├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
+│ Add Food Column              ┆ true    │
+├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
+│ Add timestamp                ┆ true    │
+├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
+│ Default Editor               ┆ hx      │
+├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
+│ Default Pager                ┆ bat     │
+├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
+│ Max rows to display for tags ┆ 5       │
+├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
+│ When to use pager            ┆ default │
+├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
+│ Default path                 ┆ ~       │
+├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌┤
+│ Approximation sensitivity    ┆ 1       │
+╰──────────────────────────────┴─────────╯</code></pre>
+
+  <h1>Dependencies</h1>
+  <ol>
+  <li><a href="https://github.com/chronotope/chrono"><code>chrono</code></a>: For date and time purposes.</li>
+  <li><a href="https://github.com/clap-rs/clap"><code>clap</code></a>: For CLI arguments.</li>
+  <li><a href="https://github.com/colored-rs/colored"><code>colored</code></a>: For colored messages.</li>
+  <li><a href="https://github.com/mikaelmello/inquire"><code>inquire</code></a>: To interactively get the date(of entry to be fetched) from the user.</li>
+  <li><a href="https://docs.rs/pager/latest/pager/"><code>pager</code></a>: To page long outputs.</li>
+  <li><a href="https://github.com/Nukesor/comfy-table"><code>comfy-table</code></a>: To print tables.</li>
+  <li><a href="https://docs.rs/toml/latest/toml/"><code>toml</code></a>: To parse the configuration file.</li>
+  <li><a href="https://serde.rs/"><code>serde</code></a>: For use in <code>toml</code> and <code>clap</code>.</li>
+  <li><a href="https://docs.rs/term_size/latest/term_size/"><code>term_size</code></a>: To get the terminal width, to be able to wrap tables and calendars accordingly.</li>
+  <li><a href="https://docs.rs/stringmetrics/latest/stringmetrics/"><code>stringmetrics</code></a>: For <i>approximate</i> word searching.</li>
+  <li><a href="https://docs.rs/shellexpand/latest/shellexpand/"><code>shellexpand</code></a>: To expand the <code>~</code>(tilde) in paths.</li>
+  </ol>
+
   <h1>Any other doubts/questions?</h1>
   Feel free to open an <a href="https://github.com/kajuburfi/jrnl/issues">issue</a>.