Skip to content

Commit c06f65a

Browse files
committed
add fmt
1 parent afac5cc commit c06f65a

File tree

39 files changed

+1717
-1125
lines changed

39 files changed

+1717
-1125
lines changed

docs/config.toml

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ build_search_index = false
1010
[markdown]
1111
# Whether to do syntax highlighting
1212
# Theme can be customised by setting the `highlight_theme` variable to a theme supported by Zola
13-
highlight_code = false
13+
highlight_code = true
14+
highlight_theme = "OneHalfLight"
1415

1516
[extra]
1617
# Put all your custom variables here

docs/content/actions/_index.md

-6
This file was deleted.

docs/content/actions/command.md

-3
This file was deleted.

docs/content/actions/copy.md

-3
This file was deleted.

docs/content/actions/file.md

-36
This file was deleted.

docs/content/actions/package.md

-3
This file was deleted.

docs/content/blog/_index.md

-6
This file was deleted.

docs/content/blog/first.md

-37
This file was deleted.

docs/content/docs/_index.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
+++
2+
title = "docs"
3+
template = "docs/page.html"
4+
sort_by = "weight"
5+
+++
6+
7+
Getting started
8+
- Installation
9+
- CLI usage
10+
- Directory structure
11+
- config.toml

docs/content/docs/actions/_index.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
+++
2+
title = "Actions"
3+
sort_by = "title"
4+
weight = 2
5+
+++

docs/content/docs/actions/command.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
+++
2+
title = "command"
3+
template = "docs/section.html"
4+
+++
5+
6+
# command
7+
8+
Run the command on the remote machine
9+
10+
### Parameters
11+
12+
| Parameter | Description |
13+
| -------------- | ----------- |
14+
| **cmd** <br> String <br>Required: true | The command to run |
15+
| **args** <br> List of String <br>Required: false | The command arguments |

docs/content/docs/actions/copy.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
+++
2+
title = "copy"
3+
template = "docs/section.html"
4+
+++
5+
6+
# copy
7+
8+
Copy the file to the remote machine
9+
10+
### Parameters
11+
12+
| Parameter | Description |
13+
| -------------- | ----------- |
14+
| **src** <br> String <br>Required: true | Local path of a file to be copied |
15+
| **dest** <br> String <br>Required: true | The path where file should be copied to on remote server |

docs/content/docs/actions/file.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
+++
2+
title = "file"
3+
template = "docs/section.html"
4+
+++
5+
6+
# file
7+
8+
Manage files/folders and their properties
9+
10+
### Parameters
11+
12+
| Parameter | Description |
13+
| -------------- | ----------- |
14+
| **path** <br> String <br>Required: true | Path of the file or folder that's managed |
15+
| **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

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
+++
2+
title = "git"
3+
template = "docs/section.html"
4+
+++
5+
6+
# git
7+
8+
Manage Git repositories
9+
10+
### Parameters
11+
12+
| Parameter | Description |
13+
| -------------- | ----------- |
14+
| **repo** <br> String <br>Required: true | address of the git repository |
15+
| **dest** <br> String <br>Required: true | The path of where the repository should be checked out. |

docs/content/docs/actions/package.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
+++
2+
title = "package"
3+
template = "docs/section.html"
4+
+++
5+
6+
# package
7+
8+
Install packages
9+
10+
### Parameters
11+
12+
| Parameter | Description |
13+
| -------------- | ----------- |
14+
| **name** <br> String or List of String <br>Required: true | the name of the packages to be installed |
15+
| **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 |
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
+++
2+
title = "Getting Started"
3+
sort_by = "weight"
4+
weight = 1
5+
+++
6+
7+
Getting started
8+
- Installation
9+
- CLI usage
10+
- Directory structure
11+
- config.toml
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
+++
2+
template = "docs/section.html"
3+
title = "overview"
4+
weight = 2
5+
+++
6+
7+
### Installation
8+
9+
Run below to install latest Tiron binary to ```/usr/local/bin```
10+
11+
```bash
12+
curl -sL https://tiron.run/install.sh | sh
13+
```
14+

0 commit comments

Comments
 (0)