Dockery/Homer
1
0
Fork 0
mirror of https://github.com/bastienwirtz/homer.git synced 2026-09-05 22:30:46 +02:00
Code Issues Packages Projects Releases Activity

Minor edits on readme and documentation

Browse Source
This commit is contained in:
simonporte
2020-11-14 13:25:01 +01:00
parent ade77e4257
commit 86f4680a5b
5 changed files with 26 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/configuration.md
View File

@@ -25,14 +25,14 @@ columns: "3" # "auto" or number (must be a factor of 12: 1, 2, 3, 4, 6, 12)
connectivityCheck: true # whether you want to display a message when the apps are not accessible anymore (VPN disconnected for example)
# Optional theming
theme: default # 'default' or one of the theme available in 'src/assets/themes'.
theme: default # 'default' or one of the themes available in 'src/assets/themes'.
# Optional custom stylesheet
# Will load custom CSS files. Especially useful for custom icon sets.
# stylesheet:
# - "assets/custom.css"
# Here is the exaustive list of customization parameters
# Here is the exhaustive list of customization parameters
# However all value are optional and will fallback to default if not set.
# if you want to change only some of the colors, feel free to remove all unused key.
colors:
@@ -83,7 +83,7 @@ links:
url: "https://github.com/bastienwirtz/homer"
# Services
# First level array represent a group.
# First level array represents a group.
# Leave only a "items" key if not using group (group name, icon & tagstyle are optional, section separation will not be displayed).
services:
- name: "Application"

16
docs/tips-and-tricks.md
View File

@@ -48,36 +48,36 @@ and then simply reference these pre-defined (anchored) tags in each item like so
```yaml
- name: "VS Code"
logo: "/assets/vscode.png"
subtitle: "Develope Code Anywhere, On Anything!"
<<: *App # Regerence to the predefined "App" Tag
subtitle: "Develop Code Anywhere, On Anything!"
<<: *App # Reference to the predefined "App" Tag
url: "https://vscode.example.com/"
target: "_blank" # optional html tag target attribute
````
Then when Homer reads your config, it will substitute your anchors automatically, the the above example is equal to:
Then when Homer reads your config, it will substitute your anchors automatically, the above example is equal to:
```yaml
- name: "VS Code"
logo: "/assets/vscode.png"
subtitle: "Develope Code Anywhere, On Anything!"
subtitle: "Develop Code Anywhere, On Anything!"
tag: "App"
tagstyle: "is-medium is-info"
url: "https://vscode.example.com/"
target: "_blank" # optional html tag target attribute
```
The 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!
The 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!
Great if you have a lot of services or a lot of tags!
## Remotely edit your config with Code Server
#### `by @JamiePhonic`
Homer doesn't yet provide a way to edit your configuration from inside Homer itself, but that doesn't mean it cant be done!
Homer doesn't yet provide a way to edit your configuration from inside Homer itself, but that doesn't mean it can't be done!
You can setup and use [Code-Server](https://github.com/cdr/code-server) to edit your `config.yml` file from anywhere!
If you're running Homer in docker, you can setup a Code-Server container and pass your homer config directory into it.
Simply pass your homer config directory as and extra -v parameter to your code-server container:
Simply pass your homer config directory as an extra -v parameter to your code-server container:
```
-v '/your/local/homer/config-dir/':'/config/homer':'rw'
```
@@ -85,7 +85,7 @@ This will map your homer config directory (For example, /docker/appdata/homer/)
As 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!
For example:
For example:
```yml
links:
- name: Edit config