Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
engram-design committed Sep 19, 2023
1 parent e73d034 commit ebd781a
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 15 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# Control Panel Nav Plugin for Craft CMS

# Control Panel Nav plugin for Craft CMS
<img width="500" src="https://verbb.imgix.net/plugins/cp-nav/cp-nav-social-card.png?v=1">

Control Panel Nav is a Craft CMS plugin to help manage your Control Panel navigation. Take control over your Craft CMS control panel navigation with CP Nav. Rename, reorder, hide and show menu items in the control panel. You can even add your own custom menu items for external links, or commonly used URLs within Craft. Divider menu items can also be added to logically group menu items into sections.

## Features

- Modify the main sidebar navigation in the Craft control panel.
- Rename, reorder, remove any existing navigation items - including plugins and modules.
- Full support for nesting items up to 2 levels deep.
Expand All @@ -21,19 +19,17 @@ Control Panel Nav is a Craft CMS plugin to help manage your Control Panel naviga
- Full support for your existing user permissions. Menu items for Craft and plugins will only be shown if the users is permitted to view them.
- Unlimited use, free forever.

<img src="https://verbb.imgix.net/plugins/v1/main-new.png" style="box-shadow: 0 4px 16px rgba(0,0,0,0.08); border-radius: 4px; border: 1px solid rgba(0,0,0,0.12);">

## Documentation
Visit the [CP Nav Plugin page](https://verbb.io/craft-plugins/cp-nav) for all documentation, guides, pricing and developer resources.
Visit the [Control Panel Nav Plugin page](https://verbb.io/craft-plugins/cp-nav) for all documentation, guides, pricing and developer resources.

## Support
Get in touch with us via the [CP Nav Support page](https://verbb.io/craft-plugins/cp-nav/support) or by [creating a Github issue](https://github.com/verbb/cp-nav/issues)
Get in touch with us via the [Control Panel Nav Support page](https://verbb.io/craft-plugins/cp-nav/support) or by [creating a Github issue](https://github.com/verbb/cp-nav/issues)

## Show your Support
CP Nav is licensed under the MIT license, meaning it will always be free and open source – we love free stuff! If you'd like to show your support to the plugin regardless, [Sponsor](https://github.com/sponsors/verbb) development.
## Sponsor
Control Panel Nav is licensed under the MIT license, meaning it will always be free and open source – we love free stuff! If you'd like to show your support to the plugin regardless, [Sponsor](https://github.com/sponsors/verbb) development.

<h2></h2>

<a href="https://verbb.io" target="_blank">
<img width="100" src="https://verbb.io/assets/img/verbb-pill.svg">
<img width="100" src="https://verbb.io/assets/img/verbb-pill.svg">
</a>
1 change: 0 additions & 1 deletion docs/feature-tour/navigation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# Navigation

This plugin allows you to rename, reorder, or toggle visibility on menu items for the Control Panel.

You can also create your own menu items to link to either pages inside the control panel, or external links.
Expand Down
4 changes: 2 additions & 2 deletions docs/get-started/installation-setup.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Installation & Setup
You can install CP Nav via the plugin store, or through Composer.
You can install Control Panel Nav via the plugin store, or through Composer.

## Craft Plugin Store
To install **CP Nav**, navigate to the _Plugin Store_ section of your Craft control panel, search for `CP Nav`, and click the _Install_ button.
To install **Control Panel Nav**, navigate to the _Plugin Store_ section of your Craft control panel, search for `Control Panel Nav`, and click the _Install_ button.

## Composer
You can also add the package to your project using Composer and the command line.
Expand Down
4 changes: 2 additions & 2 deletions docs/get-started/requirements.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Requirements

## Craft CMS
CP Nav requires Craft CMS 4.0 or greater.
Control Panel Nav requires Craft CMS 4.0 or greater.

## PHP
CP Nav requires PHP 8.0.2 or greater.
Control Panel Nav requires PHP 8.0.2 or greater.
Binary file removed docs/screenshots/main-new.png
Binary file not shown.

0 comments on commit ebd781a

Please sign in to comment.