perchcms / perch-docs Goto Github PK

JavaScript 6.24% HTML 10.64% CSS 41.02% PHP 23.55% SCSS 11.72% Handlebars 6.83%

perch-docs's Introduction

Perch documentation

All CSS changes are made in the pattern library. The build process for the docs then pulls the compiled CSS from the pattern library into the docs build.

To install the pattern library

cd perch-docs/patterns
npm install

and then to run it:

gulp

this should watch for changes and rebuild the CSS.

To install the docs

cd perch-docs
npm install

Once the pattern library is running (and therefore fresh CSS is being built) you can build the docs:

node build

The built output goes into the public folder. You can point a web server at that. The node module http-server is quite useful for this.

perch-docs's People

Contributors

Stargazers

Watchers

Forkers

husseinalhammad webbist-dev cognetif thefamiliar

perch-docs's Issues

The else attribute

The else attribute is documented in Working with Content > Templates > Understanding Conditional Tags, but not in Template Reference > Tag attributes where one would expect to find it.

Missing filtering options

Some filtering options (such as !in, !contains and !gt) are not documented. Some aliases (such as within, is, not and !eq) are not documented either.

Importer: Adding asset to a field

The example in the Using the asset section section does not work. The solution was posted on the old forum by Drew (http://forum.grabaperch.com/forum/02-08-2018-perch-shop-import-assets-not-imported#reply-57229).

PerchSmartbar

The PerchSmartbar class is not documented in the Perch API reference

Blog app: perch_blog_custom() - the author option

The author option is not listed in the options array table for perch_blog_custom().

perch_blog_custom([
    'author' => 'john-silver',
]);

The html attribute

The html attribute is not documented in Template Reference > Tag attributes.

PerchAPI_Factory

The PerchAPI_Factory is not documented in the Perch API reference.

Shop app: perch_shop_order_addresses()

The function perch_shop_order_addresses() is not documented in Order Functions.

Shop app: perch_shop_products() pagination options

The pagination options are not listed in the options array table for perch_shop_products().

The no-index attribute

The no-index attribute is not documented.

PerchAPI_Base

The PerchAPI_Base is not documented in the Perch API reference.

Namespace reminders

Would it be possible to add "namespace reminders" where applicable throughout the documentation?

For instance, I recently wanted to paginate the list of customer's previous orders on their account page. Checked with the documentation, set things up as described however couldn't get it to work. Opened an issue on the forum, fortunately, this was picked up by Hussein, who told me to change the namespace from content (as per the docs) to shop. A reminder in the docs would have save a fair bit of time.

Core icons

It would be very handy to have the core icons documented like the blocks icons. The icons can be used in multiple ways when building Perch apps. Example usage:

$Smartbar->add_item([
    'title' => 'Documents',
    'link'  => $API->app_nav() . '/documents',
    'icon'  => 'core/document',
    'active' => true,
]);