aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs
diff options
context:
space:
mode:
authorBastien Wirtz <bastien.wirtz@gmail.com>2020-10-26 14:04:15 -0700
committerGitHub <noreply@github.com>2020-10-26 14:04:15 -0700
commitff0b5150f1cef5456a685b492ee4f4f02b6e2ef5 (patch)
treecae1b7657d6b85bb982e961aae6d54ff90ba8b3c /docs
parent5a85322c927c96aee89ee0c7239e03bdab3f241d (diff)
parent2662b1704930eff56a61194a6796d463df687889 (diff)
downloadhomer-ff0b5150f1cef5456a685b492ee4f4f02b6e2ef5.tar.gz
homer-ff0b5150f1cef5456a685b492ee4f4f02b6e2ef5.tar.zst
homer-ff0b5150f1cef5456a685b492ee4f4f02b6e2ef5.zip
Merge pull request #151 from taigrr/spellcheck
chore: applies spell-check against entire repo (aspell)
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration.md2
-rw-r--r--docs/development.md4
-rw-r--r--docs/tips-and-tricks.md10
3 files changed, 8 insertions, 8 deletions
diff --git a/docs/configuration.md b/docs/configuration.md
index 7df5651..43e9ba1 100644
--- a/docs/configuration.md
+++ b/docs/configuration.md
@@ -1,6 +1,6 @@
1## Configuration 1## Configuration
2 2
3Title, icons, links, colors, and services can be configured in the `config.yml` file (located in `/assets` directory once built, or in the `public/assets` directory in developement mode), using [yaml](http://yaml.org/) format. 3Title, icons, links, colors, and services can be configured in the `config.yml` file (located in `/assets` directory once built, or in the `public/assets` directory in development mode), using [yaml](http://yaml.org/) format.
4 4
5```yaml 5```yaml
6--- 6---
diff --git a/docs/development.md b/docs/development.md
index 6ea1cba..f2e9020 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -1,4 +1,4 @@
1## Developement 1## Development
2 2
3```sh 3```sh
4# Using yarn (recommended) 4# Using yarn (recommended)
@@ -13,7 +13,7 @@ npm run serve
13### Themes 13### Themes
14 14
15Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)). 15Themes are meant to be simple customization (written in [scss](https://sass-lang.com/documentation/syntax)).
16To addd a new theme, just add a file in the theme directory, and put all style in the `body #app.theme-<name>` scope. Then import it in the main style file. 16To add a new theme, just add a file in the theme directory, and put all style in the `body #app.theme-<name>` scope. Then import it in the main style file.
17 17
18```scss 18```scss
19// `src/assets/themes/my-awesome-theme.scss` 19// `src/assets/themes/my-awesome-theme.scss`
diff --git a/docs/tips-and-tricks.md b/docs/tips-and-tricks.md
index 175c271..9f35987 100644
--- a/docs/tips-and-tricks.md
+++ b/docs/tips-and-tricks.md
@@ -7,7 +7,7 @@ Here is a collection of neat tips and tricks that Homer users have come up with!
7 7
8These extensions for [Firefox](https://addons.mozilla.org/firefox/addon/custom-new-tab-page) and [Chrome & Friends](https://chrome.google.com/webstore/detail/new-tab-changer/occbjkhimchkolibngmcefpjlbknggfh) allow you to have your homer dashboard in your new tab page, while leaving focus on the address bar meaning you can still type right away if you want to search or go to a page that is not on your homer dash. 8These extensions for [Firefox](https://addons.mozilla.org/firefox/addon/custom-new-tab-page) and [Chrome & Friends](https://chrome.google.com/webstore/detail/new-tab-changer/occbjkhimchkolibngmcefpjlbknggfh) allow you to have your homer dashboard in your new tab page, while leaving focus on the address bar meaning you can still type right away if you want to search or go to a page that is not on your homer dash.
9 9
10The firefox extension loads Homer in an iframe on your new tab page, meaning you have to add `target: '_top'` to each of your items. 10The Firefox extension loads Homer in an iframe on your new tab page, meaning you have to add `target: '_top'` to each of your items.
11 11
12```yaml 12```yaml
13- name: "Reddit" 13- name: "Reddit"
@@ -24,7 +24,7 @@ The firefox extension loads Homer in an iframe on your new tab page, meaning you
24## YAML Anchors 24## YAML Anchors
25#### `by @JamiePhonic` 25#### `by @JamiePhonic`
26 26
27Since Homer is configured using YAML, it supports all of YAML's helpful fetaures, such as anchoring! 27Since Homer is configured using YAML, it supports all of YAML's helpful features, such as anchoring!
28 28
29For example, you can define tags and tag styles for each "item" in a service. 29For example, you can define tags and tag styles for each "item" in a service.
30Using Anchoring, you can define all your tags and their styles once like this: (for example) 30Using Anchoring, you can define all your tags and their styles once like this: (for example)
@@ -66,13 +66,13 @@ Then when Homer reads your config, it will substitute your anchors automatically
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 perticular 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 doesnt 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 cant 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
@@ -123,4 +123,4 @@ So, using [Node-Red](https://nodered.org/docs/getting-started/) and a quick flow
123 123
124To get started, simply import [this flow](https://flows.nodered.org/flow/4b6406c9a684c26ace0430dd1826e95d) into your Node-Red instance and change the RSS feed in the "Get News RSS Feed" node to one of your choosing! 124To get started, simply import [this flow](https://flows.nodered.org/flow/4b6406c9a684c26ace0430dd1826e95d) into your Node-Red instance and change the RSS feed in the "Get News RSS Feed" node to one of your choosing!
125 125
126So far, the flow has been tested with BBC News and Sky News, however it should be easy to modify the flow to work with other RSS feeds if they dont work out of the box! 126So far, the flow has been tested with BBC News and Sky News, however it should be easy to modify the flow to work with other RSS feeds if they don't work out of the box!