Comply to markdownlint rules

Author: nikosev

CHANGELOG.md

@@ -1,11 +1,14 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
 
+This version is compatible with [SimpleSAMLphp v1.18](https://simplesamlphp.org/docs/1.18/simplesamlphp-changelog)
+
 ### Added
 
 - Add `login_with` key in discopower definitions
@@ -20,42 +23,66 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Move `ribbon_text` definition to config file
 - Comply to [PSR-1: Basic Coding Standard](https://www.php-fig.org/psr/psr-1/) guidelines
-- Comply to [PSR-12: Extended Coding Style](https://www.php-fig.org/psr/psr-12/) guidelines
+- Comply to [PSR-12: Extended Coding Style](https://www.php-fig.org/psr/psr-12/)
+  guidelines
 - Apply modern array syntax to comply with [SimpleSAMLphp v1.17](https://simplesamlphp.org/docs/stable/simplesamlphp-upgrade-notes-1.17)
+- Comply to [markdownlint rules](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md)
+
+<!-- markdownlint-disable line-length -->
 
 ## [v3.0.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v2.3.1...v3.0.0) - 2019-09-20
 
+<!-- markdownlint-enable line-length -->
+
 ### Added
+
 - Add languages (Xhosa, Zulu, Afrikaans).
 
 ### Changed
+
 - Rename disco-tpl.php->disco.tpl.php as needed by simplesamlphp>1.14.
 - Update translation functionality as needed by simplesamlphp>1.14.
 
+<!-- markdownlint-disable line-length -->
+
 ## [v2.3.1](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v2.3.0...v2.3.1) - 2019-09-12
 
+<!-- markdownlint-enable line-length -->
+
 ### Fixed
 
 - Fix bug in IdPs buttons style caused by unclosed html element.
 
+<!-- markdownlint-disable line-length -->
+
 ## [v2.3.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v2.2.1...v2.3.0) - 2019-08-01
 
+<!-- markdownlint-enable line-length -->
+
 ### Added
 
 - Module discopower: Add style rules and logos for the buttons of the IdPs:
   - Bitbucket
   - Github
 
+<!-- markdownlint-disable line-length -->
 
 ## [v2.2.1](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v2.2.0...v2.2.1) - 2019-07-03
 
+<!-- markdownlint-enable line-length -->
+
 ### Fixed
 
 - Fix syntax error in disco-tpl.php
 
+<!-- markdownlint-disable line-length -->
+
 ## [v2.2.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v2.1.0...v2.2.0) - 2019-06-27
 
+<!-- markdownlint-enable line-length -->
+
 ### Added
+
 - Module discopower: Add style rules and logos for the buttons of the IdPs:
   - OpenAIRE
   - OpenMinTeD
@@ -66,12 +93,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Enable/disable cookie banner functionality via setting in config file.
 
 ### Changed
+
 - Update instructions on module config file usage.
 - Update style of Google login button.
 
+<!-- markdownlint-disable line-length -->
+
 ## [v2.1.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v2.0.0...v2.1.0) - 2018-10-18
 
+<!-- markdownlint-enable line-length -->
+
 ### Added
+
 - Add banner and an extra view for cookies options.
 - Add corner ribbon that displays customisable text.
 - Add this changelog file.
@@ -81,46 +114,59 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Aria
 
 ### Changed
-  - Change vanilla logo and favicon.
-  - Move wording and links from the templates of several modules to the related
-    definition file.
-  - Render header logo link url customisable.
+
+- Change vanilla logo and favicon.
+- Move wording and links from the templates of several modules to the related
+  definition file.
+- Render header logo link url customisable.
+
+<!-- markdownlint-disable line-length -->
 
 ## [v2.0.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v1.0.0...v2.0.0) - 2018-04-17
 
+<!-- markdownlint-enable line-length -->
+
 ### Added
+
 - Module discopower:
   - Add style rules and logos for the IdPs:
     - B2ACCESS
     - DARIAH
     - Elixir
     - IGTF
   - Support customisable order of IdPs' groups based on the existing mechanism of
-  discopower.
+    discopower.
 
 ### Changed
+
 - Module discopower: Support only 2 tags for the grouping of IdPs.
 - Module userid: Add content in the error template.
 
 ### Fixed
+
 - Use the translated name to display an IdP.
 
+<!-- markdownlint-disable line-length -->
 
 ## [v1.0.0](https://github.com/rciam/simplesamlphp-module-themevanilla/compare/v0.1.0...v1.0.0) - 2018-01-19
 
+<!-- markdownlint-enable line-length -->
+
 ### Added
+
 - Use SASS for the added style rules.
 - Use Bootstrap v3.3.7.
 - Add support for error pages that are produced from several modules.
 - Add detailed instructions for the installation procedures.
 - Document configuration options.
-- Module discopower: Add enhanced style for the following  IdPs' buttons:
+- Module discopower: Add enhanced style for the following IdPs' buttons:
   - Facebook
   - Google
   - LinkedIn
   - ORCID
 
 ### Changed
+
 - Change the look n feel of several SimpleSAMLphp modules:
   - authX509
   - authorize
@@ -129,14 +175,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - default
   - discopower
   - userid
-- Module discopower: Replace the section that includes the edugain IdPs with a section that lists all IdPs.
+- Module discopower: Replace the section that includes the edugain IdPs with a
+  section that lists all IdPs.
 - Improve responsiveness of the layout.
 - Enhance the customization of the theme.
 
-
+<!-- markdownlint-disable line-length -->
 
 ## [v0.1.0](https://github.com/rciam/simplesamlphp-module-themevanilla/commits/v0.1.0) - 2018-01-12
 
+<!-- markdownlint-enable line-length -->
+
 ### Added
+
 Create a new theme for SimpleSAMLphp. The goal is to improve the experience for
 people that login to services through multiple identity providers.

README.md

@@ -1,11 +1,10 @@
-<h1 align="center">Vanilla theme for SimpleSAMLphp</h1>
+# Vanilla theme for SimpleSAMLphp
 
-![discopower](/screenshots/disco_buttons_bottom.png)
+![discopower](screenshots/disco_buttons_bottom.png)
 
 A customisable theme for SimpleSAMLphp based on Bootstrap.
 See more screens in the directory [screenshots](screenshots/).
 
-
 ## Installation
 
 You can install the theme using any of the methods below.
@@ -18,7 +17,7 @@ installation. Check the following example, that includes all the necessary
 additions for the installation of the **simplesamlphp-module-themevanilla
 v1.0.0**.
 
-```
+```json
 "require": {
 
   ...
@@ -71,13 +70,14 @@ v1.0.0**.
 ```
 
 With the above configuration composer will do several operations:
-* It will put the module `themevanilla` in the `modules` directory.
-* It will download and extract the compressed `css` and `js` directories that
+
+- It will put the module `themevanilla` in the `modules` directory.
+- It will download and extract the compressed `css` and `js` directories that
   include the minified css and javascript files.
-* It will copy the `css` and `js` directories from the `vendor/rciam` directory
+- It will copy the `css` and `js` directories from the `vendor/rciam` directory
   in the `themevanilla/www/resources` directory, where the static files of the
   theme should be placed.
-* It will place the configuration file `module_themevanilla.php` inside the
+- It will place the configuration file `module_themevanilla.php` inside the
   `config` directory of the installation.
 
 ### Direct download
@@ -92,20 +92,21 @@ of your SimpleSAMLphp installation.
 
 Clone this repository into the `modules` directory of your SimpleSAMLphp
 installation as follows:
-```
+
+```sh
 cd /path/to/simplesamlphp/modules
 git clone https://github.com/rciam/simplesamlphp-module-themevanilla.git themevanilla
 ```
+
 Note that the cloned repository will not include the css files or minified
 javascript files.
 You'll need to download or produce them. You can download the compressed
-directories (`js.zip` and `css.zip`) from the [release page](https://github.com/rciam/simplesamlphp-module-themevanilla/releases) and
-extract them under `modules/themevanilla/www/resources`.  If you want to produce
-them, you may read the customisation instructions below.
+directories (`js.zip` and `css.zip`) from the [release page](https://github.com/rciam/simplesamlphp-module-themevanilla/releases)
+and extract them under `modules/themevanilla/www/resources`. If you want to
+produce them, you may read the customisation instructions below.
 As a last step, move `example-config/module_themevanilla.php` file to the `config`
 directory of your SimpleSAMLphp installation.
 
-
 ## Configuration
 
 ### Basic usage
@@ -117,16 +118,18 @@ In order to use this module as theme you need to set in the
 
 The theme splits the discopower IdP discovery page into 2 sections, depending on
 the tags of the included IdPs:
-* The section that its IdPs have the tag `idps_in_searchable_list` contains all
+
+- The section that its IdPs have the tag `idps_in_searchable_list` contains all
   the IdPs in a list of links with a search box.
-* The section that its IdPs have the tag `idps_with_logos` contains login
+- The section that its IdPs have the tag `idps_with_logos` contains login
   buttons with specified style rules for each IdP. Each button may have a logo
   icon, too.
 
 Also, you need to define the order of the 2 sections. You can set this in the
 file `config/module_discopower.php` from the variable `taborder`.
 For example:
-```
+
+```php
 'taborder' => [
   'idps_in_searchable_list',
   'idps_with_logos'
@@ -136,7 +139,8 @@ For example:
 Especially for the of the `idps_with_logos`, you need to specify the css class
 name, icon and label of the IdP login button using the `login_button`
 configuration as follows:
-```
+
+```php
 'tags' => [
   'idps_with_logos',
 ],
@@ -146,33 +150,34 @@ configuration as follows:
   'label' => 'ORCID',
 ]
 ```
+
 To set style rules for the each button, the configured css_classname value must
 be defined in the `idps_buttons.scss` file. See more information bellow.
 
 At the moment there are style rules for the IdPs:
-* ARIA
-* B2ACCESS
-* Check-in
-* DARIAH
-* eduTEAMS
-* Elixir
-* Facebook
-* Google
-* IGTF
-* LinkedIn
-* ORCID
-* OpenAIRE
-* OpenMinTeD
+
+- ARIA
+- B2ACCESS
+- Check-in
+- DARIAH
+- eduTEAMS
+- Elixir
+- Facebook
+- Google
+- IGTF
+- LinkedIn
+- ORCID
+- OpenAIRE
+- OpenMinTeD
 
 ### Cookie Policy
 
-Cookie policy includes a banner at the bottom of each page that prompts the user to
-accept the cookies, along with a Cookies Policy page.
+Cookie policy includes a banner at the bottom of each page that prompts the
+user to accept the cookies, along with a Cookies Policy page.
 The feature is disabled by default.
 To enable it, set `enable_cookies_banner` to `true` in the configuration file:
 `<path-to-simplesamlphp>/config/module_themevanilla.php`.
 
-
 ## Customization
 
 ### Wording
@@ -183,7 +188,7 @@ You can find definitions and dictionaries in the `dictionaries` directory.
 
 Place your logo and favicon in the directory:
 `themevanilla/www/resources/images` If you name them `logo.jpg` and
-`favicon.ico` they will be loaded without any other modification.  If you name
+`favicon.ico` they will be loaded without any other modification. If you name
 them differently you need to modify the template `header.php` that is placed in:
 `themevanilla/themes/ssp/default/includes/`.
 
@@ -208,16 +213,19 @@ If you want to hide the ribbon, set `ribbon_text` to `""`.
 ### CSS
 
 To produce the css files for this theme follow these steps:
-* Install sass ([installation guide](http://sass-lang.com/install))
-* Go to the directory `themevanilla/www/resources`
-* Run the cli sass: `sass --update sass:css`
+
+- Install sass ([installation guide](http://sass-lang.com/install))
+- Go to the directory `themevanilla/www/resources`
+- Run the cli sass: `sass --update sass:css`
 
 After these steps the css files will be in the directory
 `themevanilla/www/resources/css`
 
 You can change the settings of this theme from the files:
-* `themevanilla/www/resources/sass/_settings.scss`: Here you will see the
+
+- `themevanilla/www/resources/sass/_settings.scss`: Here you will see the
   following variables:
+
   - $btn-action: background color of primary button
   - $btn-warning: background color of warning button
   - $footer-bg: footer background color
@@ -226,10 +234,10 @@ You can change the settings of this theme from the files:
   - $btn-footer-text: text color of button that is in the footer
   - $btn-footer-border: border color of button that is in the footer
 
-* `themevanilla/www/resources/sass/_colors.scss`: Here you can add or change
+- `themevanilla/www/resources/sass/_colors.scss`: Here you can add or change
   color settings.
 
-* `themevanilla/www/resources/sass/_idps_buttons.scss`: Here you can add or
+- `themevanilla/www/resources/sass/_idps_buttons.scss`: Here you can add or
   modify settings that are related with the buttons of the selected subset of
   IdPs.