From e49ea52c83660d7c732c841ab8b8ab5fedba0720 Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Mon, 26 Jul 2021 15:08:35 +0100 Subject: [PATCH 1/8] =?UTF-8?q?=F0=9F=92=B7=20Adds=20FUNDING.yml?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/FUNDING.yml | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..05f4eb5e --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,4 @@ +# Support Dashy's Development! + +github: lissy93 +custom: ['https://notes.aliciasykes.com/tip'] From 245be505d2dfc1e97625dedc40f204ddce493250 Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Mon, 26 Jul 2021 15:22:31 +0100 Subject: [PATCH 2/8] :octocat: Adds the Contributor Covenant Code of Conduct --- .github/CODE_OF_CONDUCT.md | 128 +++++++++++++++++++++++++++++++++++++ 1 file changed, 128 insertions(+) create mode 100644 .github/CODE_OF_CONDUCT.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..153dd37e --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +alicia@omg.lol. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. From 456cce0653181eb9fa35124c11872183bc6a1975 Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Mon, 26 Jul 2021 20:16:00 +0100 Subject: [PATCH 3/8] :bug: Adds safeguard for when pageInfo isnt specified --- src/utils/ConfigAccumalator.js | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/src/utils/ConfigAccumalator.js b/src/utils/ConfigAccumalator.js index 1237897c..6a5e0928 100644 --- a/src/utils/ConfigAccumalator.js +++ b/src/utils/ConfigAccumalator.js @@ -48,11 +48,12 @@ export default class ConfigAccumulator { } catch (e) { localPageInfo = {}; } + const filePageInfo = this.conf.pageInfo || {}; const pi = this.conf.pageInfo || defaults; // The page info object to return - pi.title = localPageInfo.title || conf.pageInfo.title || defaults.title; - pi.description = localPageInfo.description || conf.pageInfo.description || defaults.description; - pi.navLinks = localPageInfo.navLinks || conf.pageInfo.navLinks || defaults.navLinks; - pi.footerText = localPageInfo.footerText || conf.pageInfo.footerText || defaults.footerText; + pi.title = localPageInfo.title || filePageInfo.title || defaults.title; + pi.description = localPageInfo.description || filePageInfo.description || defaults.description; + pi.navLinks = localPageInfo.navLinks || filePageInfo.navLinks || defaults.navLinks; + pi.footerText = localPageInfo.footerText || filePageInfo.footerText || defaults.footerText; return pi; } From 2f3a641013e20524d4ae150699662f9ddc54fa26 Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Mon, 26 Jul 2021 20:49:42 +0100 Subject: [PATCH 4/8] :sparkles: Adds an optional logo image to the header, Re: #104 --- src/components/PageStrcture/Header.vue | 7 ++++++- src/components/PageStrcture/PageTitle.vue | 14 +++++++++++++- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/src/components/PageStrcture/Header.vue b/src/components/PageStrcture/Header.vue index aa49d6c3..754f3313 100644 --- a/src/components/PageStrcture/Header.vue +++ b/src/components/PageStrcture/Header.vue @@ -1,6 +1,11 @@ diff --git a/src/components/PageStrcture/PageTitle.vue b/src/components/PageStrcture/PageTitle.vue index e64a72a8..98d75212 100644 --- a/src/components/PageStrcture/PageTitle.vue +++ b/src/components/PageStrcture/PageTitle.vue @@ -1,7 +1,10 @@ @@ -11,6 +14,7 @@ export default { props: { title: String, description: String, + logo: String, }, }; @@ -20,7 +24,9 @@ export default { .page-titles { display: flex; - flex-direction: column; + flex-wrap: wrap; + flex-direction: row; + align-items: center; text-decoration: none; h1 { color: var(--heading-text-color); @@ -33,7 +39,13 @@ export default { text-shadow: 1px 1px 2px #130f23; opacity: var(--dimming-factor); } + img.site-logo { + margin: 0.2rem 0.5rem 0.2rem 0; + max-width: 3.5rem; + height: fit-content; + } @include phone { + flex-direction: column; text-align: center; padding: 0.25rem 0; } From ef6b6bb75757872f3f44f62badf16963feba1e7c Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Mon, 26 Jul 2021 20:50:22 +0100 Subject: [PATCH 5/8] :card_file_box: Adds pageInfo.logo attribute to the schema --- src/utils/ConfigSchema.json | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/utils/ConfigSchema.json b/src/utils/ConfigSchema.json index c07d1e95..874fd18b 100644 --- a/src/utils/ConfigSchema.json +++ b/src/utils/ConfigSchema.json @@ -39,6 +39,15 @@ }, "footerText": { "type": "string" + }, + "logo": { + "type": "string", + "description": "Path to an optional image asset, to be displayed in the header", + "pattern": "^(http|\/)", + "examples": [ + "/web-icons/dashy-logo.png", + "https://i.ibb.co/yhbt6CY/dashy.png" + ] } }, "required": [ From 644739028f3af0531bb44b1dc1be88d4496f3328 Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Mon, 26 Jul 2021 20:50:53 +0100 Subject: [PATCH 6/8] :memo: Adds docs for pageInfo.logo attribute --- README.md | 2 ++ docs/configuring.md | 1 + 2 files changed, 3 insertions(+) diff --git a/README.md b/README.md index 5e495cb9..bcf041bf 100644 --- a/README.md +++ b/README.md @@ -345,6 +345,8 @@ Custom links for the navigation menu are defined under [`pageInfo.navLinks`](htt You can display either custom text or HTML in the footer, using the `pageInfo.footerText` attribute. +To display a logo or image asset next to the title, set `pageInfo.logo` to the path to your picture (either local or remote). + It's also possible to hide parts of the page that you do not need (e.g. navbar, footer, search, heading, etc). This is done using the [`appConfig.hideComponents`](https://github.com/Lissy93/dashy/blob/master/docs/configuring.md#appconfighidecomponents-optional) attribute. For example, a `pageInfo` section might look something like this: diff --git a/docs/configuring.md b/docs/configuring.md index 4e1ca038..3b03513c 100644 --- a/docs/configuring.md +++ b/docs/configuring.md @@ -38,6 +38,7 @@ To disallow any changes from being written to disk via the UI config editor, set **`description`** | `string` | _Optional_ | Description of your dashboard, also displayed as a subtitle **`navLinks`** | `array` | _Optional_ | Optional list of a maximum of 6 links, which will be displayed in the navigation bar. See [`navLinks`](#pageinfonavlinks-optional) **`footerText`** | `string` | _Optional_ | Text to display in the footer (note that this will override the default footer content). This can also include HTML and inline CSS +**`logo`** | `string` | _Optional_ | The path to an image to display in the header (to the right of the title). This can be either local, where `/` is the root of `./public`, or any remote image, such as `https://i.ibb.co/yhbt6CY/dashy.png`. It's recommended to scale your image down, so that it doesn't impact load times **[⬆️ Back to Top](#configuring)** From be79049fb86a95a09657848ac1afb331011b17dd Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Mon, 26 Jul 2021 20:51:31 +0100 Subject: [PATCH 7/8] :bookmark: Bumps to V-1.4.5 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index a7c219ed..19b06176 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "Dashy", - "version": "1.4.4", + "version": "1.4.5", "license": "MIT", "main": "server", "scripts": { From 91ededa7db8bfede5f445d8559ff659e7494c7ae Mon Sep 17 00:00:00 2001 From: Alicia Sykes Date: Mon, 26 Jul 2021 21:07:12 +0100 Subject: [PATCH 8/8] :adhesive_bandage: Read logo from local storage, if available --- src/utils/ConfigAccumalator.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/utils/ConfigAccumalator.js b/src/utils/ConfigAccumalator.js index 6a5e0928..b1426eef 100644 --- a/src/utils/ConfigAccumalator.js +++ b/src/utils/ConfigAccumalator.js @@ -51,6 +51,7 @@ export default class ConfigAccumulator { const filePageInfo = this.conf.pageInfo || {}; const pi = this.conf.pageInfo || defaults; // The page info object to return pi.title = localPageInfo.title || filePageInfo.title || defaults.title; + pi.logo = localPageInfo.logo || filePageInfo.logo || defaults.logo; pi.description = localPageInfo.description || filePageInfo.description || defaults.description; pi.navLinks = localPageInfo.navLinks || filePageInfo.navLinks || defaults.navLinks; pi.footerText = localPageInfo.footerText || filePageInfo.footerText || defaults.footerText;