Download the PHP package towardstudio/websitedocumentation without Composer
On this page you can find all versions of the php package towardstudio/websitedocumentation. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download towardstudio/websitedocumentation
More information about towardstudio/websitedocumentation
Files in towardstudio/websitedocumentation
Package websitedocumentation
Short Description Add Style Guide & CMS Guide to your website
License MIT
Informations about the package websitedocumentation
Website Documentation plugin for Craft CMS 5.x
Creates two links within admin for Style Guide and CMS Guide
Requirements
This plugin requires Craft CMS 5+.
Installation
To install the plugin, follow these instructions.
-
Open your terminal and go to your Craft project:
-
Then tell Composer to load the plugin:
- In the Control Panel, go to Settings → Plugins and click the “Install” button for Website Documentation.
Usage
Installing Demo Templates
Once the plugin has installed you will see a new menu item called Documentation.
If you go to Plugin Settings -> Install Templates and click install, this will copy the default guides to your templates folder.
Within this folder you can go to Layouts -> CMS Guide / Styleguide and update the paths to where your CSS and JS live.
General Settings
Within General Settings you can add a logo, and choose colours which will be displayed across both Style and CMS Guides.
CMS Guide Settings
Here you can create the structure for your CMS Guide and add some default entries to get you started.
Adding new sections to the styleguide
If you're using the demo templates, you can add a new section by opening up the _config.twig file and adding new items to the Object. Each item can have a Sub menu as well.
The naming of these items are used in kebab case for the file in the sections folder. For example if you call a section Heroes you'll name your file heroes.twig.
Brought to you by Toward