Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
LukeTowers authored Oct 20, 2024
1 parent 8d1f15f commit 4f1bb7f
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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/).
Expand All @@ -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.
Expand Down

0 comments on commit 4f1bb7f

Please sign in to comment.