Squash move docs to main branch and add update instructions

Move docs to main branch and add update instructions

Author: raujonas

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "documentation/source/themes/hugo-book"]
+	path = documentation/source/themes/hugo-book
+	url = https://github.com/alex-shpak/hugo-book

README.md

@@ -1,5 +1,5 @@
 # **Executor - Gnome Shell Extension**
-![Maintenance](https://img.shields.io/maintenance/yes/2023)
+![Maintenance](https://img.shields.io/maintenance/yes/2024)
 ![GitHub release (latest by date)](https://img.shields.io/github/v/release/raujonas/executor)
 ![GitHub Release Date](https://img.shields.io/github/release-date/raujonas/executor)
 ![GitHub Repo stars](https://img.shields.io/github/stars/raujonas/executor?style=social)
@@ -10,6 +10,6 @@ Execute multiple shell commands periodically with separate intervals and display
 
 [<img src="https://raw.githubusercontent.com/andyholmes/gnome-shell-extensions-badge/master/get-it-on-ego.svg?sanitize=true" alt="Get it on GNOME Extensions" height="100" width="220">](https://extensions.gnome.org/extension/2932/executor/)
 
-<img src="docs/result.png" alt="result" width="967">
+<img src="readme/result.png" alt="result" width="967">
 
 ## Documentation: [here](https://raujonas.github.io/executor/)

documentation/.gitignore

@@ -0,0 +1 @@
+.hugo_build.lock

documentation/README.md

@@ -0,0 +1 @@
+See [here](https://raujonas.github.io/executor/docs/documentation/).

documentation/source/archetypes/default.md

@@ -0,0 +1,6 @@
+---
+title: "{{ replace .Name "-" " " | title }}"
+date: {{ .Date }}
+draft: true
+---
+

documentation/source/config.toml

@@ -0,0 +1,105 @@
+# hugo server --minify --themesDir ... --baseURL=http://0.0.0.0:1313/theme/hugo-book/
+
+baseURL = 'https://raujonas.github.io/executor/'
+title = 'Executor Documentation'
+theme = 'hugo-book'
+
+# hugo server --minify --theme hugo-book
+# hugo --minify --theme hugo-book
+publishDir = "../target"
+# git submodule update --remote --merge
+# git commit -m ''
+# git push
+
+# Book configuration
+disablePathToLower = true
+
+# Needed for mermaid/katex shortcodes
+[markup]
+[markup.goldmark.renderer]
+  unsafe = true
+
+[markup.tableOfContents]
+  startLevel = 1
+
+# Multi-lingual mode config
+# There are different options to translate files
+# See https://gohugo.io/content-management/multilingual/#translation-by-filename
+# And https://gohugo.io/content-management/multilingual/#translation-by-content-directory
+[languages]
+[languages.en]
+  languageName = 'English'
+  contentDir = 'content'
+  weight = 1
+
+[menu]
+# [[menu.before]]
+[[menu.after]]
+  name = "Github"
+  url = "https://github.com/raujonas/executor"
+  weight = 10
+
+[params]
+  # (Optional, default light) Sets color theme: light, dark or auto.
+  # Theme 'auto' switches between dark and light modes based on browser/os preferences
+  BookTheme = 'light'
+
+  # (Optional, default true) Controls table of contents visibility on right side of pages.
+  # Start and end levels can be controlled with markup.tableOfContents setting.
+  # You can also specify this parameter per page in front matter.
+  BookToC = false
+
+  # (Optional, default none) Set the path to a logo for the book. If the logo is
+  # /static/logo.png then the path would be logo.png
+  BookLogo = 'icons/icon.png'
+
+  # (Optional, default docs) Specify root page to render child pages as menu.
+  # Page is resoled by .GetPage function: https://gohugo.io/functions/getpage/
+  # For backward compatibility you can set '*' to render all sections to menu. Acts same as '/'
+  BookSection = 'docs'
+
+  # Set source repository location.
+  # Used for 'Last Modified' and 'Edit this page' links.
+  #BookRepo = 'https://github.com/raujonas/executor'
+
+  # (Optional, default 'commit') Specifies commit portion of the link to the page's last modified
+  # commit hash for 'doc' page type.
+  # Requires 'BookRepo' param.
+  # Value used to construct a URL consisting of BookRepo/BookCommitPath/<commit-hash>
+  # Github uses 'commit', Bitbucket uses 'commits'
+  # BookCommitPath = 'commit'
+
+  # Enable "Edit this page" links for 'doc' page type.
+  # Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
+  # Edit path must point to root directory of repo.
+  # BookEditPath = 'edit/main/exampleSite'
+
+  # Configure the date format used on the pages
+  # - In git information
+  # - In blog posts
+  BookDateFormat = 'January 2, 2006'
+
+  # (Optional, default true) Enables search function with flexsearch,
+  # Index is built on fly, therefore it might slowdown your website.
+  # Configuration for indexing can be adjusted in i18n folder per language.
+  BookSearch = true
+
+  # (Optional, default true) Enables comments template on pages
+  # By default partals/docs/comments.html includes Disqus template
+  # See https://gohugo.io/content-management/comments/#configure-disqus
+  # Can be overwritten by same param in page frontmatter
+  # BookComments = true
+
+  # /!\ This is an experimental feature, might be removed or changed at any time
+  # (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
+  # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
+  # Theme will print warning if page referenced in markdown does not exists.
+  BookPortableLinks = true
+
+  # /!\ This is an experimental feature, might be removed or changed at any time
+  # (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
+  BookServiceWorker = true
+
+  # /!\ This is an experimental feature, might be removed or changed at any time
+  # (Optional, experimental, default false) Enables a drop-down menu for translations only if a translation is present.
+  BookTranslatedOnly = false

documentation/source/content/_index.md

@@ -0,0 +1,16 @@
+---
+weight: 1
+title: "Overview"
+---
+
+# **Executor - Gnome Shell Extension**
+![Maintenance](https://img.shields.io/maintenance/yes/2024)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/raujonas/executor)
+![GitHub Release Date](https://img.shields.io/github/release-date/raujonas/executor)
+![GitHub Repo stars](https://img.shields.io/github/stars/raujonas/executor?style=social)
+
+Execute multiple shell commands periodically with separate intervals and display the output in gnome top bar.
+
+[<img src="https://raw.githubusercontent.com/andyholmes/gnome-shell-extensions-badge/master/get-it-on-ego.svg?sanitize=true" alt="Get it on GNOME Extensions" height="100" width="220">](https://extensions.gnome.org/extension/2932/executor/)
+
+<img src="docs/combined.png" alt="result" width="967">

documentation/source/content/docs/configuration/_index.md

@@ -0,0 +1,4 @@
+---
+bookCollapseSection: true
+weight: 2
+---

documentation/source/content/docs/configuration/basic/_index.md

@@ -0,0 +1,12 @@
+---
+weight: 1
+title: "Basic"
+---
+
+# **Configuration**
+
+## **Basic**
+
+The commands and the interval for each command can be set for each location (left, center, right) separately in the settings view. It is also possible to deactivate single commands without deleting them.
+
+<img src="../../../docs/settings.png" alt="settings" width="500">

documentation/source/content/docs/configuration/combine-css-and-markup/_index.md

@@ -0,0 +1,18 @@
+---
+weight: 4
+title: "Combine css and markup"
+---
+
+# **Configuration**
+
+## **Combine css and markup**
+
+Combination of css and markup is also possible. In this case the setting for markup **`<executor.markup.true>`**  must be located after all css settings. Here is an example:
+
+```
+echo " <span font_family='monospace' foreground='blue'>Blue text</span> is <i>cool</i>! <span foreground='red'>Red text</span><executor.css.green><executor.markup.true> is cool too"
+```
+
+This produces the following output:
+
+<img src="../../../docs/css-and-markup.png" alt="settings">