Craft3

.craftplugin

@@ -0,0 +1 @@
+{"pluginName":"usermanual","pluginDescription":"Craft User Manual allows developers (or even content editors) to provide CMS documentation using Craft's built-in sections (singles, channels, or structures) to create a 'User Manual' or 'Help' section directly in the control panel.","pluginVersion":"2.0.0","pluginAuthorName":"Rob Erskine","pluginVendorName":"hillholliday","pluginAuthorUrl":"https://twitter.com/erskinerob","pluginAuthorGithub":"hillholliday","codeComments":"","pluginComponents":["settings","twigextensions","variables"],"consolecommandName":"","controllerName":"","cpsectionName":"","elementName":"","fieldName":"","modelName":"","purchasableName":"","recordName":"","serviceName":"","taskName":"","utilityName":"","widgetName":"","apiVersion":"api_version_3_0"}

.editorconfig

@@ -0,0 +1,15 @@
+; top-most EditorConfig file
+root = true
+
+; Unix-style newlines
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = LF
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.php]
+indent_style = space
+indent_size = 4

.gitignore

@@ -0,0 +1,32 @@
+# CRAFT ENVIRONMENT
+.env.php
+.env.sh
+.env
+
+# COMPOSER
+/vendor
+
+# BUILD FILES
+/bower_components/*
+/node_modules/*
+/build/*
+/yarn-error.log
+
+# MISC FILES
+.cache
+.DS_Store
+.idea
+.project
+.settings
+*.esproj
+*.sublime-workspace
+*.sublime-project
+*.tmproj
+*.tmproject
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+config.codekit3
+prepros-6.config

CHANGELOG.md

@@ -0,0 +1,9 @@
+# usermanual Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## 2.0.0 - 2018-08-24
+### Added
+- Initial Craft 3 release

LICENSE.md

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Rob Erskine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,34 +1,67 @@
-# Craft User Manual
+# Craft User Manual plugin for Craft CMS 3.x
 
 Craft User Manual allows developers (or even content editors) to provide CMS documentation using Craft's built-in sections (singles, channels, or structures) to create a "User Manual" or "Help" section directly in the control panel.
 
-![How it works](http://cl.ly/image/2a3g0J3h3d3j/Craft-User-Manual-2.5.jpg)
+![Screenshot](resources/img/screenshot.jpg)
 
----
+## Requirements
+
+This plugin requires Craft CMS 3.0.0-beta.23 or later.
 
 ## Installation
-1. Copy the included **usermanual** folder into craft/plugins.
-2. Navigate to Plugins in the Craft CP.
-3. Click the Install button in the row for the **User Manual** plugin.
+
+To install the plugin, follow these instructions.
+
+1. Open your terminal and go to your Craft project:
+
+        cd /path/to/project
+
+2. Then tell Composer to load the plugin:
+
+        composer require hillholliday/usermanual
+
+3. In the Control Panel, go to Settings → Plugins and click the “Install” button for usermanual.
+
 4. Select the section the plugin should use as the **User Manual** page in the CP.
     * (Optional) - Replace the plugin's name to something your user's will understand.
     * (Optional) - Use more than the default `body` fieldhandle by setting up custom template overrides.
+
 5. Click the **User Manual** link in the CP nav.
 
+## Configuration
+
+* All settings may be optionally configured using a [config file](http://buildwithcraft.com/docs/plugins/plugin-settings#config-file). The values, contained in [`config.php`](https://github.com/hillholliday/Craft-User-Manual/blob/master/usermanual/config.php), are described below:
+
+<a id="config-settings-pluginNameOverride"></a>
+### pluginNameOverride
+Intuitive, human-readable plugin name for the end user.
+
+<a id="config-settings-templateOverride"></a>
+### templateOverride
+For more control over the output, you may optionally override the default template.
+
+Path is relative to ../craft/templates/.
+
+<a id="config-settings-section"></a>
+### section
+Entries in this section must have associated urls.
+
 ## Some notes
 * The plugin currently only pulls in the `body` field from each entry in the selected section, unless you're using a template override.
 * While the **User Manual** section works best with `Structures`, you can certainly get away with using a one-off `Single`.
 * If you're running _Craft Client_ or _Craft Pro_ make sure your content editors don't have permission to edit whatever section you've selected to use as your **User Manual**
 * Only sections with entry URLs may be used as your **User Manual** section.
-* All settings may be optionally configured using a [config file](http://buildwithcraft.com/docs/plugins/plugin-settings#config-file). See [`config.php`](https://github.com/hillholliday/Craft-User-Manual/blob/master/usermanual/config.php) for possible values.
 
 ## Thanks
 This plugin was inspired by the team over at [70kft](http://70kft.com/) for their work on [Craft-Help](https://github.com/70kft/craft-help). While their plugin is definitely more flexible in terms of writing custom markdown in separate files, we wanted to create something that would make it easier for anyone to edit documentation without making any changes to the server. This works particularly well for larger projects where more than one person (especially non-devs) are writing documentation for how to use the CMS.
 
 ## Releases
+* **2.0.0** - Craft3 version of Craft User Manual.
 * **1.1.1** - Adding in RTL language support
 * **1.1.0** - Merging in @timkelty's work which includes template overrides, updated error prompts, and other misc improvements
 * **1.0.1** - Adding support for plugin custom icons in Craft 2.5
 * **1.0.0** - Initital release of Craft User Manual.
 
 We hope this plugin is useful, and we'd love to hear any suggestions or issues you may have. [@erskinerob](https://twitter.com/erskinerob).
+
+Brought to you by [Rob Erskine](https://twitter.com/erskinerob)

composer.json

@@ -0,0 +1,40 @@
+{
+    "name": "hillholliday/Craft-User-Manual",
+    "description": "Craft User Manual allows developers (or even content editors) to provide CMS documentation using Craft's built-in sections (singles, channels, or structures) to create a `User Manual` or `Help` section directly in the control panel.",
+    "type": "craft-plugin",
+    "version": "2.0.0",
+    "keywords": [
+        "craft",
+        "cms",
+        "craftcms",
+        "craft-plugin",
+        "usermanual"
+    ],
+    "support": {
+        "docs": "https://github.com/hillholliday/Craft-User-Manual/blob/master/README.md",
+        "issues": "https://github.com/hillholliday/Craft-User-Manual/issues"
+    },
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Rob Erskine",
+            "homepage": "https://twitter.com/erskinerob"
+        }
+    ],
+    "require": {
+        "craftcms/cms": "^3.0.0-RC1"
+    },
+    "autoload": {
+        "psr-4": {
+          "hillholliday\\usermanual\\": "src/"
+        }
+    },
+    "extra": {
+        "name": "User Manual",
+        "handle": "usermanual",
+        "hasCpSettings": true,
+        "hasCpSection": true,
+        "changelogUrl": "https://raw.githubusercontent.com/hillholliday/Craft-User-Manual/master/CHANGELOG.md",
+        "class": "hillholliday\\usermanual\\UserManual"
+    }
+}