{"id":13446860,"url":"https://github.com/kalvn/Shaarli-Material","last_synced_at":"2025-03-21T16:32:59.936Z","repository":{"id":28855953,"uuid":"32380003","full_name":"kalvn/Shaarli-Material","owner":"kalvn","description":"Shaarli Material is a theme for Shaarli, the famous personal, minimalist, super-fast, database free, bookmarking service.","archived":false,"fork":false,"pushed_at":"2024-12-23T14:40:43.000Z","size":5378,"stargazers_count":252,"open_issues_count":8,"forks_count":23,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-12-23T14:46:58.929Z","etag":null,"topics":["bookmark","link","material","self-hosted","shaarli","theme"],"latest_commit_sha":null,"homepage":"https://github.com/kalvn/Shaarli-Material","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kalvn.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-03-17T08:16:20.000Z","updated_at":"2024-12-23T14:00:14.000Z","dependencies_parsed_at":"2024-10-28T11:27:23.970Z","dependency_job_id":"9ab93cbb-5ef4-458f-981f-77ac96dc0d24","html_url":"https://github.com/kalvn/Shaarli-Material","commit_stats":null,"previous_names":[],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kalvn%2FShaarli-Material","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kalvn%2FShaarli-Material/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kalvn%2FShaarli-Material/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kalvn%2FShaarli-Material/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kalvn","download_url":"https://codeload.github.com/kalvn/Shaarli-Material/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244829649,"owners_count":20517349,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bookmark","link","material","self-hosted","shaarli","theme"],"created_at":"2024-07-31T05:01:01.724Z","updated_at":"2025-03-21T16:32:59.913Z","avatar_url":"https://github.com/kalvn.png","language":"HTML","funding_links":[],"categories":["HTML","self-hosted"],"sub_categories":[],"readme":"# Shaarli Material Theme\nShaarli Material is a theme for [Shaarli](https://github.com/shaarli/Shaarli), the famous personal, minimalist, super-fast, database free, bookmarking service.\n\n\n## Screenshots\n![Shaarli Material Screenshot Home](https://raw.githubusercontent.com/kalvn/Shaarli-Material/master/screenshots/showcase.png)\n\n[More screenshots](https://github.com/kalvn/Shaarli-Material/tree/master/screenshots).\n\n\n## Compatibility\nShaarli Material follows the exact same versions numbers than Shaarli. It means that if you install Shaarli vX.Y.Z, you must use Shaarli Material vX.Y.Z.\n\nShaarli Material was tested and validated with **Shaarli 0.14.0**.\n\n\n## Download\nTo download this theme, [visit this page](https://github.com/kalvn/Shaarli-Material/releases) and choose the most recent version matching the version of your Shaarli installation. Both use the same notation.\n\nVersions suffixed by `-patch.x` include some bugfix so take those preferentially if they exist for the version that fits your Shaarli installation.\n\nIf you install an older version, please read the README.md file you'll find in the root folder rather than this one.\n\n\n## Installation\nDownload the `material` folder into the `tpl` directory of your Shaarli installation next to the `default` directory.\n\nAccess your Shaarli and finish the setup process. Then, go into menu **Tools \u003e Configure your Shaarli** and change the setting **Theme** to **Material**.\n\nYou can now enjoy your new Material theme.\n\n\n## Customization\n### Configuration\nYou can customize a few things using the `data/config.json.php` file of your Shaarli installation. If the file doesn't exist, just create it. Be careful to respect the JSON format notation (end lines with a comma except for the last item, just before the closing curly brace), otherwise you'll get errors.\n\nHere are parameters you can set.\n\n- `config.MATERIAL_PHP_DATE_PATTERN` (optional): Customizes the date format. Check this to know what to write: https://php.net/manual/function.strftime.php (ex: `\"%d/%m/%Y\"` will output for example '30/05/2015').\n- `config.MATERIAL_NO_QRCODE` (optional): Removes the QR code control of the theme. To completely get rid of QR Codes, you of course need to disable the qrcode plugin as well.\n- `config.MATERIAL_COLOR` (optional): Customizes the theme's colors. It's used for example on Android for notification bar. It will generate `\u003cmeta name=\"theme-color\" content=\"YOURCOLORHERE\"\u003e`.\n\n\nHere is an example of what you can configure (in real life, there will be other parameters in the file, just add those to the different categories):\n\n```json\n{\n    \"resource\": {\n        \"raintpl_tpl\": \"tpl\\/material\\/\"\n    },\n\n    \"config\": {\n        \"MATERIAL_PHP_DATE_PATTERN\": \"%d\\/%m\\/%Y %H:%M:%S\",\n        \"MATERIAL_NO_QRCODE\": true,\n        \"MATERIAL_COLOR\": \"#607D8B\"\n    }\n}\n```\n\n### Custom Open Graph image\n[Open Graph](https://ogp.me/#metadata) is a protocol that enables web site developers to attach rich metadata that will be used when sharing a link on social medias for example.\n\nShaarli Material supports adding a custom image that will be used by default when no image is attached to a shared link.\n\nTo add yours, create a PNG image and save it as `tpl/material/opengraph.png`.\n\n### Custom CSS\nYou can add your own CSS rules in file `data/user.css`. You'll find an example that shows how to change the whole theme color in `user.example.css`.\n\n\n## Add custom resources\nIf you want to add your custom scripts or styles (for example analytics script), you must create a new template named `extra.html` in the *material* folder.\nThen, anything you add in this file will be included at the end of the `\u003chead\u003e` tag.\n\nThis file is NOT commited on the repository, which allows you to update the theme without overriding this file.\n\n\n## Plugins\nAs from Shaarli v0.6.0, you can install plugins to enrich your experience.\nMost of them should work properly, although it's up to the plugin developer to ensure the code is as minimal as possible to integrates well in custom themes.\nI tested all plugins available with Shaarli 0.6.0 and they all work well even though the display is a bit weird for some of them. I will keep monitoring the behavior of popular plugins in the future.\n\n\n## Libraries used\nThis theme uses a few JavaScript libraries.\n\n- [jQuery](http://jquery.com/)\n- [Bootstrap](http://getbootstrap.com/)\n- [awesomplete](http://leaverou.github.io/awesomplete/)\n- [blazy](http://dinbror.dk/blazy/)\n- [Sortable](http://rubaxa.github.io/Sortable/)\n- [Salvattore](https://salvattore.js.org/)\n- [Autosize](https://github.com/jackmoore/autosize/)\n- [node-qrcode](https://github.com/soldair/node-qrcode)\n\n\n## Demo\nA read-only demo is available on my personal Shaarli : [https://links.kalvn.net](https://links.kalvn.net)\n\n\n## Develop and debug\nTo tweak this theme, you'll need to install dependencies and to build JavaScript and CSS libraries. To do this, install [Node.js and NPM](https://nodejs.org) and run this from the root folder:\n\n```bash\n$ npm install\n$ npm run dev\n```\n\n\n## Build for production\n\n```bash\n$ npm install\n$ npm run build\n```\n\n------------------------------------------------------------------------------\n\nYou can download Shaarli via the Github project page: https://github.com/shaarli/Shaarli\n\nOriginal project page: http://sebsauvage.net/wiki/doku.php?id=php:shaarli\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkalvn%2FShaarli-Material","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkalvn%2FShaarli-Material","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkalvn%2FShaarli-Material/lists"}