Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 3.11 KB

README.md

File metadata and controls

74 lines (50 loc) · 3.11 KB
Raw

Shaarli Custom CSS Plugin

Shaarli plugin to customize the look and feel of the UI with custom CSS rules.

Tested on Shaarli 0.12.0-beta with the default theme but it should work with the Shaarli-Material and all built-in themes as well.

Features

  • Set up your custom CSS rules on the Plugin Administration page for easy configuration

Installation

The plugin's folder (custom_css) should be placed in the <shaarli>/plugins/ directory.

The directory structure should look like:

└── plugins
    └── custom_css
        ├── custom_css.html
        ├── custom_css.meta
        └── custom_css.php

To enable the plugin, just check it in the Plugin Administration page (?do=pluginadmin).

You can also add custom_css to your list of enabled plugins in data/config.json.php.
The general.enabled_plugins list should look like then:

"general": {
  "enabled_plugins": [
    ...other_plugins_above,
    "custom_css"
  ],
}

Configuration

Go to the Plugin Administration page, and edit the following settings (with the plugin enabled).

  • CUSTOM_CSS:
    Your CSS as one huge line. Default empty
    Example value: .some-class { color: red; font-size: 1.2em } .another-class { margin: 0; }
    Supported values: any string (without validation!), defaults to empty.

Note: this setting can also be set in data/config.json.php, in the plugins section:

"general": {
    "plugins": {
        "CUSTOM_CSS": ".some-class { color: red; font-size: 1.2em } .another-class { margin: 0; }",
        [...]
    },
}

Known issues

  • ⚠️ There is no validation on the CSS file contents upon saving and loading! Your only "protection" against a self-XSS attack is the rel="stylesheet" attribute on the link. It should be enough but please consider your attack vector.

Recommendations

Put this plugin to the bottom of the enabled plugins list either in the config JSON file or via the administration UI. This lets you redefine other plugins CSS rules as well.

An example CSS you can try out for starting customizations over the default theme: .linklist-item, .linklist-item-title, .linklist-item-infos, .page-form, .page-form .window-title, .linksperpage a, .linklist-filters .filter-off, .linksperpage input[type="text"], .searchform-block input[type="text"] { background: #fff } .linklist-item-infos-url { display: none } .linklist-item-infos-dateblock { width: 100% } .linklist-item-title h2 { line-height: 1em; padding: 0.3em 10px 0.3em } .linklist-item-infos .label-tag { background: #f4f4f4; } .label-tag a { color: #595959 } .linklist-item-infos .linklist-item-tags { font-size: .8em; padding: 0.2em 0 0.7em; }

Shaarli Custom CSS works best with my Shaarli Markdown Toolbar plugin, check it out, too! 😉

Contact

Immánuel Fodor
fodor.it | Linkedin