From 25dd2f001365c302102abe7224583330c88718c0 Mon Sep 17 00:00:00 2001 From: Kevin Decherf Date: Mon, 23 Sep 2024 13:58:55 +0200 Subject: [PATCH] Update callouts Signed-off-by: Kevin Decherf --- content/en/admin/custom_css.md | 4 ++-- content/en/admin/installation/installation.md | 12 ++++++------ content/en/admin/installation/requirements.md | 4 ++-- content/en/admin/installation/virtualhosts.md | 14 +++++++------- content/en/admin/internal_settings.md | 8 ++++---- content/en/admin/mailer.md | 4 ++-- content/en/admin/parameters.md | 4 ++-- content/en/admin/upgrade/_index.md | 4 ++-- content/en/developer/paywall.md | 4 ++-- content/en/user/articles/download.md | 4 ++-- content/en/user/articles/restricted.md | 4 ++-- content/en/user/errors_during_fetching.md | 6 ++++-- 12 files changed, 37 insertions(+), 35 deletions(-) diff --git a/content/en/admin/custom_css.md b/content/en/admin/custom_css.md index d63e6aa..3f4f79a 100644 --- a/content/en/admin/custom_css.md +++ b/content/en/admin/custom_css.md @@ -3,9 +3,9 @@ title: Custom CSS weight: 3 --- -{% hint style="tip" %} +{{< callout type="info" >}} Available since 2.4.0 version. -{% endhint %} +{{< /callout >}} You can apply some custom styles to your wallabag instance. diff --git a/content/en/admin/installation/installation.md b/content/en/admin/installation/installation.md index 54b6885..bb1a337 100644 --- a/content/en/admin/installation/installation.md +++ b/content/en/admin/installation/installation.md @@ -17,18 +17,18 @@ If it's your first installation, you can safely answer "yes" when asking to rese Now, read the next step to create your virtual host, then access your wallabag. -{% hint style="info" %} +{{< callout type="info" >}} To define parameters with environment variables, you have to set these variables with `SYMFONY__` prefix, for example, `SYMFONY__DATABASE_DRIVER`. You can have a look at [Symfony documentation](http://symfony.com/doc/current/cookbook/configuration/external_parameters.html). -{% endhint %} +{{< /callout >}} -{% hint style="tip" %} +{{< callout type="info" >}} If you want to use SQLite to store your data, please put `%kernel.root_dir%/../data/db/wallabag.sqlite` for the `database_path` parameter during installation. -{% endhint %} +{{< /callout >}} -{% hint style="info" %} +{{< callout type="info" >}} If you're installing wallabag behind Squid as a reverse proxy, make sure to update your `squid.conf` configuration to include `login=PASS` in the `cache_peer` line. This is necessary for API calls to work properly. -{% endhint %} +{{< /callout >}} ## On shared hosting diff --git a/content/en/admin/installation/requirements.md b/content/en/admin/installation/requirements.md index 13436c7..ab324fa 100644 --- a/content/en/admin/installation/requirements.md +++ b/content/en/admin/installation/requirements.md @@ -5,9 +5,9 @@ weight: 1 wallabag is compatible with **PHP >= 7.4**. -{% hint style="info" %} +{{< callout type="info" >}} To install wallabag easily, we provide a `Makefile`, so you need to have the `make` tool. -{% endhint %} +{{< /callout >}} ## Composer diff --git a/content/en/admin/installation/virtualhosts.md b/content/en/admin/installation/virtualhosts.md index e6e2be7..03fe0cc 100644 --- a/content/en/admin/installation/virtualhosts.md +++ b/content/en/admin/installation/virtualhosts.md @@ -3,14 +3,14 @@ title: Virtual hosts weight: 3 --- -{% hint style="tip" %} +{{< callout type="info" >}} We assume that wallabag was installed in the `/var/www/wallabag` folder. -{% endhint %} +{{< /callout >}} -{% hint style="danger" %} +{{< callout type="warning" >}} The following configurations are given as examples, assuming that wallabag will be directly accessed at the root of `domain.tld` (or a `wallabag.domain.tld` subdomain). Installation in folders can work, but is not supported by the maintainers. -{% endhint %} +{{< /callout >}} ## Configuration on Apache @@ -81,10 +81,10 @@ Installation in folders can work, but is not supported by the maintainers. ``` -{% hint style="danger" %} -Do not forget to activate the *rewrite* mod of Apache: +{{< callout type="warning" >}} +Do not forget to activate the *rewrite* mod of Apache: `a2enmod rewrite && systemctl reload apache2` -{% endhint %} +{{< /callout >}} Note for Apache 2.4, in the section ``, you have to replace the directives: diff --git a/content/en/admin/internal_settings.md b/content/en/admin/internal_settings.md index b42d487..771c393 100644 --- a/content/en/admin/internal_settings.md +++ b/content/en/admin/internal_settings.md @@ -85,9 +85,9 @@ URL of your Unmark.it instance. ### Enable .mobi export -{% hint style="warning" %} +{{< callout type="warning" >}} MOBI export has been deprecated in 2.5.0 and will be removed in 2.6.0. -{% endhint %} +{{< /callout >}} `1` to activate .mobi export, `0` to deactivate. @@ -129,9 +129,9 @@ Username of the account used for demo. Once this feature is activated, the articles pictures will be downloaded in the `/web/assets/images` folder of your wallabag instance. The path of pictures in articles will also be updated to the path of pictures which are on your instance. -{% hint style="tip" %} +{{< callout type="info" >}} If you want GIFs to keep animation, install `imagick` PHP extension. It's mostly available through distros packet management as `php-imagick`. -{% endhint %} +{{< /callout >}} ### Support URL for wallabag diff --git a/content/en/admin/mailer.md b/content/en/admin/mailer.md index d51a50c..9842760 100644 --- a/content/en/admin/mailer.md +++ b/content/en/admin/mailer.md @@ -16,11 +16,11 @@ Since 2.6.6, the `gmail` transport is available again using the DSN: `gmail+smtp note: In a case, that after supplying urlencoded characters, the start up process crashes, try "escaping" them with additional % character: eg. pass%20word -> pass%%20word. Might be useful for Google App Passwords. -{% hint style="tip" %} +{{< callout type="info" >}} Symfony can support other transports which aren't shipped by default with wallabag: Amazon SES, MailChimp, Mailgun, Postmark & SendGrid. You can install them using Composer. It's a more complex step to do, [check the Symfony documentation about that](https://symfony.com/doc/4.4/mailer.html). -{% endhint %} +{{< /callout >}} ## Before wallabag 2.6.1 diff --git a/content/en/admin/parameters.md b/content/en/admin/parameters.md index db52d32..d2d1263 100644 --- a/content/en/admin/parameters.md +++ b/content/en/admin/parameters.md @@ -9,9 +9,9 @@ Here is the last version of the default app/config/parameters.yml file. Be sure that yours respects this one. If you don't know which value you need to set, please leave the default one. -{% hint style="tip" %} +{{< callout type="info" >}} To apply changes to `parameters.yml`, you have to clear your cache by deleting everything in `var/cache` with this command: `bin/console cache:clear --env=prod`. -{% endhint %} +{{< /callout >}} ```yaml parameters: diff --git a/content/en/admin/upgrade/_index.md b/content/en/admin/upgrade/_index.md index d9c9796..3190e14 100644 --- a/content/en/admin/upgrade/_index.md +++ b/content/en/admin/upgrade/_index.md @@ -12,9 +12,9 @@ You will find here different ways to upgrade your wallabag: - [from 2.x.y to 2.3.x](#upgrading-from-2xy-to-23x) - [from 1.x to 2.x](#from-wallabag-1x) -{% hint style="info" %} +{{< callout type="info" >}} But **first**, ensure you have `composer` installed on your server (or at least the `composer.phar` binary in the root directory of wallabag). If not, [please install it](https://getcomposer.org/download/). -{% endhint %} +{{< /callout >}} ## Upgrading from 2.5.x to 2.6.x diff --git a/content/en/developer/paywall.md b/content/en/developer/paywall.md index e5914c6..b7ae853 100644 --- a/content/en/developer/paywall.md +++ b/content/en/developer/paywall.md @@ -6,9 +6,9 @@ weight: 8 # Configuring paywall access -{% hint style="working" %} +{{< callout icon="beaker" >}} This is the technical part about the paywall. If you are looking for the user part, please check [that page instead](../user/articles/restricted.md). -{% endhint %} +{{< /callout >}} Read [this part of the documentation](../user/errors_during_fetching.md) to understand the configuration files, which are located under `vendor/j0k3r/graby-site-config/`. For most of the websites, this file diff --git a/content/en/user/articles/download.md b/content/en/user/articles/download.md index ad17bae..b1501fd 100644 --- a/content/en/user/articles/download.md +++ b/content/en/user/articles/download.md @@ -6,9 +6,9 @@ weight: 3 You can download each article in several formats: ePUB, MOBI, PDF, XML, JSON, CSV. -{% hint style="warning" %} +{{< callout type="warning" >}} MOBI export has been deprecated in 2.5.0 and will be removed in 2.6.0. -{% endhint %} +{{< /callout >}} On the article view, click on this icon, in the sidebar: diff --git a/content/en/user/articles/restricted.md b/content/en/user/articles/restricted.md index b054e61..f3846b2 100644 --- a/content/en/user/articles/restricted.md +++ b/content/en/user/articles/restricted.md @@ -39,9 +39,9 @@ Once enable, you'll see a new item in the top-right menu: **Site Credentials**. Click on it to go to the management of your site credentials. You'll be able to add many login / password. -{% hint style="info" %} +{{< callout type="info" >}} These information will only be accessible by **YOU** and no other users on the wallabag instance. -{% endhint %} +{{< /callout >}} ## Security diff --git a/content/en/user/errors_during_fetching.md b/content/en/user/errors_during_fetching.md index 80d3c65..ca97bff 100644 --- a/content/en/user/errors_during_fetching.md +++ b/content/en/user/errors_during_fetching.md @@ -73,9 +73,11 @@ monolog: More detailed logs will then be available in `var/logs/graby.log`, with most of the steps taken by graby to try and fetch your article. If you can't solve the issue with these logs, paste the file `var/logs/graby.log` in [a new issue on GitHub](https://github.com/wallabag/wallabag/issues/new). -{% hint style="tip" %} It is possible to have **extremely** detailed logs on the modifications made by graby while fetching, parsing and cleaning the HTML code of one article, using `level: debug` instead of `level: info` in the `graby:` section above. +{{< callout type="info" >}} +It is possible to have **extremely** detailed logs on the modifications made by graby while fetching, parsing and cleaning the HTML code of one article, using `level: debug` instead of `level: info` in the `graby:` section above. -It is very useful when writing site configuration file (see below); one must note however that all the HTML code is stored in all its intermediary states and that the log file will grow very rapidly. Use with caution :){% endhint %} +It is very useful when writing site configuration file (see below); one must note however that all the HTML code is stored in all its intermediary states and that the log file will grow very rapidly. Use with caution :) +{{< /callout >}} ### Creation/update of a site configuration file