docs: migrate wiki into main repo

2025-07-02 11:11:04 +02:00 · 2022-11-06 22:52:21 +00:00 · 2022-11-06 22:52:21 +00:00 · 58d55db660
commit 58d55db660
parent 1c032ae8e3
16 changed files with 1727 additions and 0 deletions
--- a/docs/modules/Clock.md
+++ b/docs/modules/Clock.md
@ -0,0 +1,77 @@
+Displays the current date and time. 
+Clicking on the widget opens a popup with the time and a calendar.
+
+![Screenshot of clock widget with popup open](https://user-images.githubusercontent.com/5057870/184540521-2278bdec-9742-46f0-9ac2-58a7b6f6ea1d.png)
+
+
+## Configuration
+
+> Type: `clock`
+
+| Name     | Type   | Default          | Description                                                                                                                                |
+|----------|--------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------|
+| `format` | `string` | `%d/%m/%Y %H:%M` | Date/time format string. Detail on available tokens can be found here: <https://docs.rs/chrono/latest/chrono/format/strftime/index.html> |
+
+<details>
+<summary>JSON</summary>
+
+```json
+{
+  "end": [
+    {
+      "type": "clock",
+      "format": "%d/%m/%Y %H:%M"
+    }
+  ]
+}
+
+```
+
+</details>
+
+<details>
+<summary>TOML</summary>
+
+```toml
+[[end]]
+type = "clock"
+format = "%d/%m/%Y %H:%M"
+```
+
+</details>
+
+<details>
+<summary>YAML</summary>
+
+```yaml
+end:
+  - type: "clock"
+    format: "%d/%m/%Y %H:%M"
+```
+
+</details>
+
+<details>
+<summary>Corn</summary>
+
+```corn
+{
+  end = [
+    {
+      type = "clock"
+      format = "%d/%m/%Y %H:%M"
+    }
+  ]
+}
+```
+
+</details>
+
+## Styling
+
+| Selector                      | Description                                                                        |
+|-------------------------------|------------------------------------------------------------------------------------|
+| `#clock`                      | Clock widget button                                                                |
+| `#popup-clock`                | Clock popup box                                                                    |
+| `#popup-clock #calendar-clock` | Clock inside the popup                                                             |
+| `#popup-clock #calendar`       | Calendar widget inside the popup. GTK provides some OOTB styling options for this. |