Skip to content

Commit

Permalink
Docs improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
ddnexus committed Feb 29, 2024
1 parent 63c4220 commit a1d7906
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
13 changes: 10 additions & 3 deletions docs/api/stylesheets.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,17 @@ image: none

<img src="/pagy/docs/assets/images/pagy-style.png" width="300" title="Pagy Style">

For all its own interactive helpers the pagy gem includes a few stylesheets files that you can download, link or copy.
For all its own interactive helpers shown above, the pagy gem includes a few stylesheets files that you can download, link or
copy.

!!!warning
You don't need any stylesheet if you use a frontend extra
like: [bootstrap](/docs/extras/bootstrap), [bulma](/docs/extras/bulma), [foundation](/docs/extras/foundation), [materialize](/docs/extras/materialize), [semantic](/docs/extras/semantic), [uikit](/docs/extras/uikit)
!!!

!!!success
You can adapt the stylesheets to anything you need by just editing content inside the curly brackets, usually leaving the rest
You can adapt the stylesheets below to anything you need by just editing the content inside the curly brackets, usually leaving
the rest
untouched.
!!!

Expand Down Expand Up @@ -47,6 +54,6 @@ stylesheet_path = Pagy.root.join('stylesheets', 'pagy.tailwind.scss')
+++

!!!
You can also quickly interact with all the pagy styles (including `pagy` and `tailwind`) by running the single-file self-contaied
You can also quickly check and interact with all the pagy and (a few) extra styles (including `pagy` and `tailwind`) by running the single-file self-contaied
app [!file](/apps/pagy_styles.ru)
!!!
5 changes: 3 additions & 2 deletions quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ icon: rocket-24

Ensure to have `rack` installed (or `gem install rack`)

Download and run the following self contained file
Download and run any of the following self contained file:

[!file](apps/pagy_standalone.ru)
[!file](/apps/pagy_styles.ru)

+++ Pagy Console

Expand All @@ -26,6 +26,7 @@ gem install pagy
|||

[Use it fully without any app](docs/api/console.md)

+++
===

Expand Down

0 comments on commit a1d7906

Please sign in to comment.