aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorsimonporte <32496803+simonporte@users.noreply.github.com>2020-11-14 13:25:01 +0100
committersimonporte <32496803+simonporte@users.noreply.github.com>2020-11-14 13:25:01 +0100
commit86f4680a5bc3b4cdfd865ff90d435fa7ad2d5376 (patch)
tree0843266b36d9794e32142c0662ceae2aae59204c /docs
parentade77e42578998abc44434c495b41bde37552fe0 (diff)
downloadhomer-86f4680a5bc3b4cdfd865ff90d435fa7ad2d5376.tar.gz
homer-86f4680a5bc3b4cdfd865ff90d435fa7ad2d5376.tar.zst
homer-86f4680a5bc3b4cdfd865ff90d435fa7ad2d5376.zip
Minor edits on readme and documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md6
-rw-r--r--docs/tips-and-tricks.md16
2 files changed, 11 insertions, 11 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index 32de050..681d62a 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -25,14 +25,14 @@ columns: "3" # "auto" or number (must be a factor of 12: 1, 2, 3, 4, 6, 12)
25connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example) 25connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example)
26 26
27# Optional theming 27# Optional theming
28theme: default # 'default' or one of the theme available in 'src/assets/themes'. 28theme: default # 'default' or one of the themes available in 'src/assets/themes'.
29 29
30# Optional custom stylesheet 30# Optional custom stylesheet
31# Will load custom CSS files. Especially useful for custom icon sets. 31# Will load custom CSS files. Especially useful for custom icon sets.
32# stylesheet: 32# stylesheet:
33# - "assets/custom.css" 33# - "assets/custom.css"
34 34
35# Here is the exaustive list of customization parameters 35# Here is the exhaustive list of customization parameters
36# However all value are optional and will fallback to default if not set. 36# However all value are optional and will fallback to default if not set.
37# if you want to change only some of the colors, feel free to remove all unused key. 37# if you want to change only some of the colors, feel free to remove all unused key.
38colors: 38colors:
@@ -83,7 +83,7 @@ links:
83 url: "https://github.com/bastienwirtz/homer" 83 url: "https://github.com/bastienwirtz/homer"
84 84
85# Services 85# Services
86# First level array represent a group. 86# First level array represents a group.
87# Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed). 87# Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
88services: 88services:
89 - name: "Application" 89 - name: "Application"
diff --git a/docs/tips-and-tricks.md b/docs/tips-and-tricks.md
index 9f35987..2719fc5 100644
--- a/docs/tips-and-tricks.md
+++ b/docs/tips-and-tricks.md
@@ -48,36 +48,36 @@ and then simply reference these pre-defined (anchored) tags in each item like so
48```yaml 48```yaml
49- name: "VS Code" 49- name: "VS Code"
50 logo: "/assets/vscode.png" 50 logo: "/assets/vscode.png"
51 subtitle: "Develope Code Anywhere, On Anything!" 51 subtitle: "Develop Code Anywhere, On Anything!"
52 <<: *App # Regerence to the predefined "App" Tag 52 <<: *App # Reference to the predefined "App" Tag
53 url: "https://vscode.example.com/" 53 url: "https://vscode.example.com/"
54 target: "_blank" # optional html tag target attribute 54 target: "_blank" # optional html tag target attribute
55```` 55````
56 56
57Then when Homer reads your config, it will substitute your anchors automatically, the the above example is equal to: 57Then when Homer reads your config, it will substitute your anchors automatically, the above example is equal to:
58 58
59```yaml 59```yaml
60- name: "VS Code" 60- name: "VS Code"
61 logo: "/assets/vscode.png" 61 logo: "/assets/vscode.png"
62 subtitle: "Develope Code Anywhere, On Anything!" 62 subtitle: "Develop Code Anywhere, On Anything!"
63 tag: "App" 63 tag: "App"
64 tagstyle: "is-medium is-info" 64 tagstyle: "is-medium is-info"
65 url: "https://vscode.example.com/" 65 url: "https://vscode.example.com/"
66 target: "_blank" # optional html tag target attribute 66 target: "_blank" # optional html tag target attribute
67``` 67```
68 68
69The end result is that if you want to update the name or style of any particular tag, just update it once, in the tags section! 69The end result is that if you want to update the name or style of any particular tag, just update it once, in the tags section!
70Great if you have a lot of services or a lot of tags! 70Great if you have a lot of services or a lot of tags!
71 71
72## Remotely edit your config with Code Server 72## Remotely edit your config with Code Server
73#### `by @JamiePhonic` 73#### `by @JamiePhonic`
74 74
75Homer doesn't yet provide a way to edit your configuration from inside Homer itself, but that doesn't mean it cant be done! 75Homer doesn't yet provide a way to edit your configuration from inside Homer itself, but that doesn't mean it can't be done!
76 76
77You can setup and use [Code-Server](https://github.com/cdr/code-server) to edit your `config.yml` file from anywhere! 77You can setup and use [Code-Server](https://github.com/cdr/code-server) to edit your `config.yml` file from anywhere!
78 78
79If you're running Homer in docker, you can setup a Code-Server container and pass your homer config directory into it. 79If you're running Homer in docker, you can setup a Code-Server container and pass your homer config directory into it.
80Simply pass your homer config directory as and extra -v parameter to your code-server container: 80Simply pass your homer config directory as an extra -v parameter to your code-server container:
81``` 81```
82-v '/your/local/homer/config-dir/':'/config/homer':'rw' 82-v '/your/local/homer/config-dir/':'/config/homer':'rw'
83``` 83```
@@ -85,7 +85,7 @@ This will map your homer config directory (For example, /docker/appdata/homer/)
85 85
86As a bonus, Code-Server puts the "current folder" as a parameter in the URL bar, so you could add a `links:` entry in Homer that points to your code-server instance with the directory pre-filled for essentially 1 click editing! 86As a bonus, Code-Server puts the "current folder" as a parameter in the URL bar, so you could add a `links:` entry in Homer that points to your code-server instance with the directory pre-filled for essentially 1 click editing!
87 87
88For example: 88For example:
89```yml 89```yml
90links: 90links:
91 - name: Edit config 91 - name: Edit config