From eb2df6d82ca44a2872310b4c2bf8ccbfb8da8eb2 Mon Sep 17 00:00:00 2001 From: Domizio Demichelis Date: Wed, 12 May 2021 13:22:57 +0700 Subject: [PATCH] updated docs [skip ci] --- docs/api/javascript.md | 2 +- docs/how-to.md | 2 +- pagy-on-docker/README.md | 10 ++++------ 3 files changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/api/javascript.md b/docs/api/javascript.md index 415f16ca0..0235d68ac 100644 --- a/docs/api/javascript.md +++ b/docs/api/javascript.md @@ -16,7 +16,7 @@ If you use any of them you should follow this documentation, if not, consider th ### Basic principle -All the `pagy*_js` helpers produce/render their component on the client side. The helper methods serve just a minimal HTML tag and a `JSON` tag that gets into the view. The javascript in the [pagy.js](https://github.com/ddnexus/pagy/blob/master/lib/javascripts/pagy.js) file takes care to read the data embedded in the `ISON` tag and make it work in the browser. +All the `pagy*_js` helpers render their component on the client side. The helper methods serve just a minimal HTML tag that contains a `data-pagy-json` attribute. The javascript in the [pagy.js](https://github.com/ddnexus/pagy/blob/master/lib/javascripts/pagy.js) file takes care to read the data embedded in the `data-pagy-json` attribute and make it work in the browser. ## Usage diff --git a/docs/how-to.md b/docs/how-to.md index d6e152adf..5fc704b9a 100644 --- a/docs/how-to.md +++ b/docs/how-to.md @@ -650,7 +650,7 @@ If your requirements allow to use the `countless` extra (minimal or automatic UI ## Preventing crawlers to follow look-alike links -The `*_js` helpers come with a JSON tag including a string that looks like an `a` link tag. It's just a placeholder string used by `pagy.js` in order to create actual DOM elements links, but some crawlers are reportedly following it even if it is not a DOM element. That causes server side errors reported in your log. +The `*_js` helpers come with a `data-pagy-json` attribute that includes an HTML encoded string that looks like an `a` link tag. It's just a placeholder string used by `pagy.js` in order to create actual DOM elements links, but some crawlers are reportedly following it even if it is not a DOM element. That causes server side errors reported in your log. You may want to prevent that by simply adding the following lines to your `robots.txt` file: diff --git a/pagy-on-docker/README.md b/pagy-on-docker/README.md index 0d77683d5..6db59cf55 100644 --- a/pagy-on-docker/README.md +++ b/pagy-on-docker/README.md @@ -26,12 +26,10 @@ The pagy docker environment has been designed to be useful for developing: You have a couple of alternatives: 1. (recommended) Permanently set a few environment variables about your user in your IDE or system (it will be easier for the future): - - - the `GROUP` name (get it with `id -gn` in the terminal) - - if `echo $UID` return nothing, then set the `UID` (get it with `id -u` in the terminal) - - if `echo $GID` return nothing, then set the `GID` (get it with `id -g` in the terminal) - - (Notice: you can also specify a few other variables used in the `docker-compose.yml` file.) + - the `GROUP` name (get it with `id -gn` in the terminal) + - if `echo $UID` return nothing, then set the `UID` (get it with `id -u` in the terminal) + - if `echo $GID` return nothing, then set the `GID` (get it with `id -g` in the terminal) + - (Notice: you can also specify a few other variables used in the `docker-compose.yml` file.) ```sh cd pagy-on-docker