From 4f1bb7f8d9c3047d768e1fc227dc4b33a089dcf6 Mon Sep 17 00:00:00 2001 From: Luke Towers Date: Sun, 20 Oct 2024 00:53:10 -0600 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 19d49cb..b2b867a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,19 @@ -# Pages plugin +# Static Pages plugin + +[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/wintercms/wn-pages-plugin/blob/main/LICENSE) This plugin allows end users to create and edit static pages and menus with a simple WYSIWYG user interface. +Supports: +- Static Pages +- [Placeholders](https://github.com/wintercms/wn-pages-plugin/blob/main/docs/documentation.md#placeholders) +- [Snippets](https://github.com/wintercms/wn-pages-plugin/blob/main/docs/documentation.md#snippets) +- [Menus](https://github.com/wintercms/wn-pages-plugin/blob/main/docs/documentation.md#static-menus) +- Menu Items (Built-in and [custom](https://github.com/wintercms/wn-pages-plugin/blob/main/docs/documentation.md#creating-new-menu-item-types), with support for [custom form fields](https://github.com/wintercms/wn-pages-plugin/blob/main/docs/documentation.md#custom-menu-item-form-fields)) +- [Breadcrumbs](https://github.com/wintercms/wn-pages-plugin/blob/main/docs/documentation.md#breadcrumbs) +- [`staticpagepicker` FormWidget](https://github.com/wintercms/wn-pages-plugin/blob/main/docs/documentation.md#backend-forms) +- [Custom page / layout fields](https://github.com/wintercms/wn-pages-plugin/blob/main/docs/documentation.md#custom-page-fields) + ## Installation This plugin is available for installation via [Composer](http://getcomposer.org/). @@ -10,6 +22,12 @@ This plugin is available for installation via [Composer](http://getcomposer.org/ composer require winter/wn-pages-plugin ``` +After installing the plugin you will need to run the migrations and (if you are using a [public folder](https://wintercms.com/docs/develop/docs/setup/configuration#using-a-public-folder)) [republish your public directory](https://wintercms.com/docs/develop/docs/console/setup-maintenance#mirror-public-files). + +```bash +php artisan migrate +``` + ## Managing static pages Static pages are managed on the Pages tab of the Static Pages plugin. Static pages have three required parameters - **Title**, **URL** and **Layout**. The URL is generated automatically when the Title is entered, but it could be changed manually. URLs must start with the forward slash character. The Layout drop-down allows to select a layout created with the CMS. Only layouts that include the `staticPage` component are displayed in the drop-down.