|
| 1 | +# ProcessWire “Regular” site installation profile |
| 2 | + |
| 3 | +## A Uikit v3 based blog site using Markup Regions |
| 4 | + |
| 5 | +The front-end of this profile uses the [Uikit 3](https://getuikit.com/) |
| 6 | +library and includes a library of time-saving functions for working |
| 7 | +with Uikit 3. It stays with the default Uikit styles and we've tried |
| 8 | +to keep it as generic “Uikit” look as possible. That way, when someone |
| 9 | +wants to use it to build a site, there is very little they have to |
| 10 | +reverse engineer or remove. It also means that you should be able to |
| 11 | +plug in any Uikit 3 theme and have everything adjust perfectly to that |
| 12 | +theme. We currently have no theme being applied, so you just see the |
| 13 | +generic Uikit output. |
| 14 | + |
| 15 | +[Live example](https://demo.processwire.com/regular/) |
| 16 | + |
| 17 | +## Highlights |
| 18 | + |
| 19 | +- This profile includes a [blog component](http://demo.processwire.com/regular/blog/) |
| 20 | + and demonstrates how to build a simple blog in ProcessWire. |
| 21 | + |
| 22 | +- The profile uses [Markup Regions](https://processwire.com/docs/front-end/output/markup-regions/) |
| 23 | + and the ProcessWire [Functions API](https://processwire.com/api/ref/functions/#pwapi-methods-Functions-API). |
| 24 | + |
| 25 | +- It uses the new Uikit 3 on the front-end in template files and includes |
| 26 | + a handy PHP library of Uikit-specific functions. |
| 27 | + |
| 28 | +- One of the template files (`basic-page-edit.php`) demonstrates how to |
| 29 | + implement front-end editing features. When logged in (and page is |
| 30 | + editable) you can edit any pages using that template on the front-end. |
| 31 | + |
| 32 | +- Uses pagination (after 10+ blog posts) and demonstrates use of comments |
| 33 | + as well. Includes a `ukPagination()` function which tailors ProcessWire's |
| 34 | + MarkupPagerNav module to deliver Uikit pagination. |
| 35 | + |
| 36 | +- Demonstrates use of a Page reference field, as used by |
| 37 | +[categories](http://demo.processwire.com/regular/categories/) |
| 38 | +in the blog. |
| 39 | + |
| 40 | +- The template files are easy-to-read and modify, and serve as a good |
| 41 | + platform to build from. Use of Markup Regions makes them simple to |
| 42 | + follow in the same way that template files using direct output tend |
| 43 | + to be simple to follow. |
| 44 | + |
| 45 | +- Demonstrates implementation of a custom hook function (see in the |
| 46 | + `/site/ready.php` file). |
| 47 | + |
| 48 | +## Uikit v3 functions library |
| 49 | + |
| 50 | +This site profile also includes a Uikit 3 PHP function library that |
| 51 | +simplifies some of the more verbose bits of markup you might need when |
| 52 | +using Uikit 3 with ProcessWire. For instance, creating a recursive |
| 53 | +navigation tree using uk-nav, generating a uk-navbar with dropdowns, |
| 54 | +rendering uk-pagination, or any number of other things. We find it |
| 55 | +helpful to have a few helper functions to avoid markup redundancy in |
| 56 | +multiple template files. |
| 57 | + |
| 58 | +You'll see this library included with the site profile, even though |
| 59 | +it doesn't itself need to use all of the functions that are included. |
| 60 | + |
| 61 | + |
| 62 | + |
0 commit comments