Skip to content
This repository was archived by the owner on Oct 13, 2025. It is now read-only.

Commit bed056e

Browse files
authored
Clean readme, add note about minifying html
1 parent f86f698 commit bed056e

File tree

1 file changed

+17
-13
lines changed

1 file changed

+17
-13
lines changed

README.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,19 @@ then browse to /dev/build?flush=all
2020
Several of these helpers are disabled by default but can be enabled in the config.
2121
2222
23-
#Requirements#
23+
# Requirements
2424
* Silverstripe 3.1+
2525
* php5.4+
2626
* php5-intl Package
2727
28-
#Extension Overview#
28+
# Extension Overview
2929
30-
##DataListExtension##
30+
## DataListExtension
3131
- Adds a new *ListColumn* function to a DataList to allow implode() style functionality of the list items
3232
e.g. `$list->ListColumn('ID', ' |')` would result in something like "1 |18 |19 |24".
3333
- Automatically applied
3434

35-
##ExtraPageFieldsExtension##
35+
## ExtraPageFieldsExtension
3636
- Moves the metadata fields to a new tab
3737
- Adds a new "Meta Title" field
3838
- Automatically applied
@@ -58,31 +58,35 @@ class Page extends SiteTree {
5858
}
5959
6060
}
61-
````
62-
63-
##FooterMenuExtension##
61+
```
62+
63+
## Relative Assets Extension
64+
- Prefixes all references to `assets/*` with a preceeding slash i.e. they become something like `/assets/some.png`
65+
- If [zaininnari/html-minifier](https://github.com/zaininnari/html-minifier) is installed minifies the HTML output before rendering.
66+
67+
## FooterMenuExtension
6468
- Adds a new *ShowInFooter* option to the page settings
6569
- Adds a new `FooterPages()` function to the SiteTree to return only pages that have this checked
6670

67-
##ImageExtension##
71+
## ImageExtension
6872
- Adds a new *Image Alt Text* option to the image settings
6973
- Makes the image settings fields full width
7074
- Automatically applied
7175

72-
##LinkExtension##
76+
## LinkExtension
7377
- Adds a new *SEO Text* option to the link settings
7478
- Adds a *force download* checkbox to the link if it's set to a file.
7579
- Automatically applied
7680

77-
#Template Providers Overview#
81+
# Template Providers Overview
7882

79-
##HelpersTemplateProvider
83+
## HelpersTemplateProvider
8084
- Adds a new `Repeat($times)` function to the templates to return a loopable list (kind of like a for loop)
8185
- Adds a new `Dump($obj)` function to the templates to allow easy dumping of any template variable
8286

83-
#Extendable Classes Overview#
87+
# Extendable Classes Overview
8488

85-
##OwnerPermissionedDataObject##
89+
## OwnerPermissionedDataObject
8690
- Allows data objects to inherit the access permissions from their attached relation parent
8791
- Relation parent defaults to `Page()`
8892
- If `static::$relationOwner` is set to `null` will fall back to asking the standard `Page` for permission

0 commit comments

Comments
 (0)