add fmt

docs/config.toml

@@ -10,7 +10,8 @@ build_search_index = false
 [markdown]
 # Whether to do syntax highlighting
 # Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola
-highlight_code = false
+highlight_code = true
+highlight_theme = "OneHalfLight"
 
 [extra]
 # Put all your custom variables here

docs/content/docs/_index.md

@@ -0,0 +1,11 @@
++++
+title = "docs"
+template = "docs/page.html"
+sort_by = "weight"
++++
+
+Getting started
+ - Installation
+ - CLI usage
+ - Directory structure
+ - config.toml

docs/content/docs/actions/_index.md

@@ -0,0 +1,5 @@
++++
+title = "Actions"
+sort_by = "title"
+weight = 2
++++

docs/content/docs/actions/command.md

@@ -0,0 +1,15 @@
++++
+title = "command"
+template = "docs/section.html"
++++
+
+# command
+
+Run the command on the remote machine
+
+### Parameters
+
+| Parameter      | Description |
+| -------------- | ----------- |
+| **cmd** <br> String <br>Required: true | The command to run |
+| **args** <br> List of String <br>Required: false | The command arguments |

docs/content/docs/actions/copy.md

@@ -0,0 +1,15 @@
++++
+title = "copy"
+template = "docs/section.html"
++++
+
+# copy
+
+Copy the file to the remote machine
+
+### Parameters
+
+| Parameter      | Description |
+| -------------- | ----------- |
+| **src** <br> String <br>Required: true | Local path of a file to be copied |
+| **dest** <br> String <br>Required: true | The path where file should be copied to on remote server |

docs/content/docs/actions/file.md

@@ -0,0 +1,15 @@
++++
+title = "file"
+template = "docs/section.html"
++++
+
+# file
+
+Manage files/folders and their properties
+
+### Parameters
+
+| Parameter      | Description |
+| -------------- | ----------- |
+| **path** <br> String <br>Required: true | Path of the file or folder that's managed |
+| **state** <br> Enum of "file", "absent", "directory" <br>Required: false | Default to `file`<br><br>If `file`, a file will be managed.<br>If `directory`, a directory will be recursively created and all of its parent components if they are missing.<br>If `absent`, directories will be recursively deleted and all its contents, and files or symlinks will be unlinked. |

docs/content/docs/actions/git.md

@@ -0,0 +1,15 @@
++++
+title = "git"
+template = "docs/section.html"
++++
+
+# git
+
+Manage Git repositories
+
+### Parameters
+
+| Parameter      | Description |
+| -------------- | ----------- |
+| **repo** <br> String <br>Required: true | address of the git repository |
+| **dest** <br> String <br>Required: true | The path of where the repository should be checked out. |

docs/content/docs/actions/package.md

@@ -0,0 +1,15 @@
++++
+title = "package"
+template = "docs/section.html"
++++
+
+# package
+
+Install packages
+
+### Parameters
+
+| Parameter      | Description |
+| -------------- | ----------- |
+| **name** <br> String or List of String <br>Required: true | the name of the packages to be installed |
+| **state** <br> Enum of "present", "absent", "latest" <br>Required: true | Whether to install or remove or update packages<br>`present` to install<br>`absent` to remove<br>`latest` to update |

docs/content/docs/getting-started/_index.md

@@ -0,0 +1,11 @@
++++
+title = "Getting Started"
+sort_by = "weight"
+weight = 1
++++
+
+Getting started
+ - Installation
+ - CLI usage
+ - Directory structure
+ - config.toml

docs/content/docs/getting-started/overview.md

@@ -0,0 +1,14 @@
++++
+template = "docs/section.html"
+title = "overview"
+weight = 2
++++
+
+### Installation
+
+Run below to install latest Tiron binary to ```/usr/local/bin```
+
+```bash
+curl -sL https://tiron.run/install.sh | sh
+```
+