diff options
author | Bastien Wirtz <bastien.wirtz@gmail.com> | 2020-05-16 23:35:25 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-05-16 23:35:25 -0700 |
commit | 55e0df5386b60935c3db568a94b70d4d6c0f0f49 (patch) | |
tree | ced7552cf016f9daf47fd896bf9a152e3243057d /README.md | |
parent | b317857892921423479b713fb530f5d07d1f5d82 (diff) | |
parent | 7bb903e6930cb865923b02ed2e1af8000c678924 (diff) | |
download | homer-55e0df5386b60935c3db568a94b70d4d6c0f0f49.tar.gz homer-55e0df5386b60935c3db568a94b70d4d6c0f0f49.tar.zst homer-55e0df5386b60935c3db568a94b70d4d6c0f0f49.zip |
Merge pull request #53 from fbartels/readme
Lint Readme with markdownlint
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 19 |
1 files changed, 9 insertions, 10 deletions
@@ -1,4 +1,5 @@ | |||
1 | # Homer | 1 | # Homer |
2 | |||
2 | A dead simple static **HOM**epage for your serv**ER** to keep your services on hand, from a simple `yaml` configuration file. | 3 | A dead simple static **HOM**epage for your serv**ER** to keep your services on hand, from a simple `yaml` configuration file. |
3 | 4 | ||
4 | **Check out the live demo [here](https://homer-demo.netlify.app).** | 5 | **Check out the live demo [here](https://homer-demo.netlify.app).** |
@@ -16,9 +17,9 @@ If you need authentication support, you're on your own (it can be secured using | |||
16 | 17 | ||
17 | ## Roadmap | 18 | ## Roadmap |
18 | 19 | ||
19 | - [ ] Colors / theme customization | 20 | * [ ] Colors / theme customization |
20 | - [ ] Enable PWA support (making possible to "install" - add to homescreen - it) | 21 | * [ ] Enable PWA support (making possible to "install" - add to homescreen - it) |
21 | - [ ] Improve maintenability (external library import & service workers cached file list.) | 22 | * [ ] Improve maintainability (external library import & service workers cached file list.) |
22 | 23 | ||
23 | ## Installation | 24 | ## Installation |
24 | 25 | ||
@@ -32,12 +33,10 @@ sudo docker run -p 8080:8080 -v /your/local/config.yml:/www/config.yml -v /your/ | |||
32 | 33 | ||
33 | **How to build / install it?** There is no build system (😱), use it like that! It's meant to be stupid simple & zero maintenance required. Just copy the static files somewhere, and visit the `index.html`. | 34 | **How to build / install it?** There is no build system (😱), use it like that! It's meant to be stupid simple & zero maintenance required. Just copy the static files somewhere, and visit the `index.html`. |
34 | 35 | ||
35 | |||
36 | ## Configuration | 36 | ## Configuration |
37 | 37 | ||
38 | Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format. | 38 | Title, icons, links, colors, and services can be configured in the `config.yml` file, using [yaml](http://yaml.org/) format. |
39 | 39 | ||
40 | |||
41 | ```yaml | 40 | ```yaml |
42 | --- | 41 | --- |
43 | # Homepage configuration | 42 | # Homepage configuration |
@@ -63,7 +62,7 @@ links: | |||
63 | - name: "ansible" | 62 | - name: "ansible" |
64 | icon: "fab fa-github" | 63 | icon: "fab fa-github" |
65 | url: "https://github.com/xxxxx/ansible/" | 64 | url: "https://github.com/xxxxx/ansible/" |
66 | target: '_blank' # optionnal html a tag target attribute | 65 | target: '_blank' # optional html a tag target attribute |
67 | - name: "Wiki" | 66 | - name: "Wiki" |
68 | icon: "fas fa-book" | 67 | icon: "fas fa-book" |
69 | url: "https://wiki.xxxxxx.com/" | 68 | url: "https://wiki.xxxxxx.com/" |
@@ -82,7 +81,7 @@ services: | |||
82 | subtitle: "Continuous integration server" | 81 | subtitle: "Continuous integration server" |
83 | tag: "CI" | 82 | tag: "CI" |
84 | url: "#" | 83 | url: "#" |
85 | target: '_blank' # optionnal html a tag target attribute | 84 | target: '_blank' # optional html a tag target attribute |
86 | - name: "RabbitMQ Management" | 85 | - name: "RabbitMQ Management" |
87 | logo: "/assets/tools/rabbitmq.png" | 86 | logo: "/assets/tools/rabbitmq.png" |
88 | subtitle: "Manage & monitor RabbitMQ server" | 87 | subtitle: "Manage & monitor RabbitMQ server" |
@@ -119,9 +118,9 @@ If you choose to fetch message information from an endpoint, the output format s | |||
119 | 118 | ||
120 | ```json | 119 | ```json |
121 | { | 120 | { |
122 | "style": null, | 121 | "style": null, |
123 | "title": "Lorem ipsum 42", | 122 | "title": "Lorem ipsum 42", |
124 | "content": "LA LA LA Lorem ipsum dolor sit amet, ....." | 123 | "content": "LA LA LA Lorem ipsum dolor sit amet, ....." |
125 | } | 124 | } |
126 | ``` | 125 | ``` |
127 | 126 | ||