added initializer_example.rb

docs/how-to.md

@@ -41,6 +41,10 @@ or with a template:
 <%== render 'pagy/nav', locals: {pagy: @pagy} %>
 ```
 
+## Configuring
+
+Pagy should work out of the box for most Rack based apps (e.g. Rails) even without configuring anything, however you can configure all its features by creating a `pagy.rb` initializer file, copying the content of the [initializer_example.rb](https://github.com/ddnexus/pagy/blob/master/lib/pagy/extras/initializer_example.rb) and uncomment and edit what you may need.
+
 ## Items per page
 
 You can control the items per page with the `items` variable. (Default `20`)

lib/pagy/extras/initializer_example.rb

@@ -0,0 +1,54 @@
+# Example of initializer file
+# Customize only what you really need but notice that Pagy works also without any of the following lines.
+
+
+# Extras
+# See https://ddnexus.github.io/pagy/extras
+
+# Array: Paginate arrays efficiently avoiding expensive array-wrapping and wihout overriding
+# See https://ddnexus.github.io/pagy/extras/array
+# require 'pagy/extras/array'
+
+# Bootstrap: Nav helper and templates for Bootstrap pagination
+# See https://ddnexus.github.io/pagy/extras/bootstrap
+# require 'pagy/extras/bootstrap'
+
+# Compact: An alternative UI that combines the pagination with the nav info in one compact element
+# See https://ddnexus.github.io/pagy/extras/compact
+# require 'pagy/extras/compact'
+
+# I18n: Uses the `I18n` gem instead of the pagy implementation
+# https://ddnexus.github.io/pagy/extras/i18n
+# require 'pagy/extras/i18n'
+
+# Responsive: On resize, the number of page links will adapt in real-time to the available window or container width
+# See https://ddnexus.github.io/pagy/extras/responsive
+# require 'pagy/extras/responsive'
+
+
+# Pagy Variables
+# All the Pagy::VARS here are set for all the pagy instances but can be
+# overridden by just passing them to Pagy.new or the pagy controller method
+
+# Core variables (See https://ddnexus.github.io/pagy/api/pagy#core-variables)
+# Pagy::VARS[:items] = 20                                   # default
+# Pagy::VARS[:size]  = [1,4,4,1]                            # default
+
+# Non Core Variables (See https://ddnexus.github.io/pagy/api/pagy#non-core-variables)
+# Pagy::VARS[:link_extra] = 'data-remote="true"'            # example
+# Pagy::VARS[:item_path]  = 'activerecord.models.product'   # example
+
+# Extras Non Core Variables
+# See https://ddnexus.github.io/pagy/extras/responsive#breakpoints
+# Pagy::VARS[:breakpoints] = { 0 => [1,2,2,1], 350 => [2,3,3,2], 550 => [3,4,4,3] }    # example of width/size pairs
+
+
+# I18n Variables
+# See https://ddnexus.github.io/pagy/api/frontend#pagy_tpath-vars
+# Pagy::I18N[:file]    = Pagy.root.join('locales', 'pagy.yml').to_s      # default
+# Pagy::I18N[:plurals] = -> (c) {([:zero, :one][c] || :other).to_s       # default
+
+
+# Rails: extras assets path required by compact or responsive extras
+# See https://ddnexus.github.io/pagy/extras/compact and https://ddnexus.github.io/pagy/extras/responsive
+# Rails.application.config.assets.paths << Pagy.root.join('pagy', 'extras', 'javascripts')