Merge branch 'develop' into v1

README.md

@@ -4,7 +4,7 @@
 
 Twig Profiler allows you to profile sections of your Twig templates, and see the resulting timings in the Yii2 Debug Toolbar
 
-![Screenshot](resources/img/plugin-logo.png)
+![Screenshot](./docs/docs/resources/img/plugin-logo.png)
 
 ## Requirements
 
@@ -22,68 +22,13 @@ To install the plugin, follow these instructions.
 
         composer require nystudio107/craft-twigprofiler
 
-3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Twig Profiler.
+3. Install the plugin via `./craft install/plugin twig-profiler` via the CLI, or in the Control Panel, go to Settings → Plugins and click the “Install” button for Twig Profiler.
 
 Or you can install the plugin via the **Plugin Store** in the Craft CMS 3 Control Panel.
 
-## Twig Profiler Overview
+## Documentation
 
-Twig Profiler lets you record profiling information on chunks of your Twig template code, so you can see how long it takes to execute.
-
-## Configuring Twig Profiler
-
-To use Twig Profiler, you'll need to enable the [Yii2 Debug Toolbar](https://yii2-framework.readthedocs.io/en/stable/guide/tool-debugger/), since it's what is used to display the profile information.
-
-![Screenshot](resources/screenshots/enable-debug-toolbar.png)
-
-To enable it, go to the your Account page, and click on the **Preferences** tab. Then check the **Show the debug toolbar on the front end** and/or **Show the debug toolbar on the Control Panel** checkboxes, depending on where you want the toolbar to appear.
-
-You'll then have the Debug Toolbar appearing at the bottom of your pages:
-
-![Screenshot](resources/screenshots/debug-toolbar.png)
-
-If you want to learn more about the Debug Toolbar, check out the [Profiling your Website with Craft CMS 3’s Debug Toolbar](https://nystudio107.com/blog/profiling-your-website-with-craft-cms-3s-debug-toolbar) article.
-
-## Using Twig Profiler
-
-### Quick Overview
-
-To use Twig Profiler, just wrap any chunks of Twig code you like in:
-
-```twig
-{% profile "woof" %}
-    {# code goes here #}
-{% endprofile %}
-```
-The parameter you pass in (`woof` in the above example) should be unique per profile block, so you can identity it when looking at the profiling data.
-
-Reload your page, and then click on the **Time** section of the Debug Toolbar, and you'll see your profile data:
-
-![Screenshot](resources/screenshots/performance-profiling.png)
-
-The **Duration** column shows how long it took to execute the chunk of code inside of the `{% profile %}` block.
-
-The **Category** column shows the type of the profile sample, which will always been **Twig Profiler** along with the name of the template, for profile data collected by Twig Profiler.
-
-The **Info** column shows the unique identifier we passed in.
-
-You can filter the display to show only the **Category** or **Info** you want by typing into the text boxes above the columns.
-
-Clicking on the **Timeline** section on the left will show you a visual timeline of the profile data:
-
-![Screenshot](resources/screenshots/performance-timeline.png)
-
-Hovering over the green sections will show you the **Info** identifier you passed in.
-
-### Pro Tips
-
-You can have as many `{% profile %}` block tags a page as you like, and they can wrap around any Twig code you like (`include`, `block`, whatever).
-
-You can nest `{% profile %}` block tags as much as you like.
-
-Profile data is only collected when `devMode` is on. If you turn `devMode` off, the `{% profile %}` block tags do nothing, so you can safely leave them in your production code.
-
-Under the hood, it uses the exact same method that Craft/Yii2 use to record profiling data.
+Click here -> [Twig Profiler Documentation](https://nystudio107.com/plugins/twig-profiler/documentation)
 
 ## Twig Profiler Roadmap
 

composer.json

@@ -11,8 +11,8 @@
         "twig profiler"
     ],
     "support": {
-        "docs": "https://github.com/nystudio107/craft-twigprofiler/blob/master/README.md",
-        "issues": "https://github.com/nystudio107/craft-twigprofiler/issues"
+        "docs": "https://nystudio107.com/plugins/twig-profiler/documentation",
+        "issues": "https://nystudio107.com/plugins/twig-profiler/support"
     },
     "license": "MIT",
     "authors": [

docs/.gitignore

@@ -0,0 +1,2 @@
+/vendor
+/node_modules

docs/docs/.vuepress/config.js

@@ -0,0 +1,12 @@
+module.exports = {
+    title: 'Twig Profiler Documentation',
+    description: 'Documentation for the Twig Profiler plugin',
+    base: '/docs/twig-profiler/',
+    dest: '../../../../sites/nystudio107/web/docs/twig-profiler',
+    themeConfig: {
+        displayAllHeaders: true,
+        sidebar: [
+            ['/', 'Twig Profiler plugin for Craft CMS 3.x'],
+        ]
+    }
+};

docs/docs/README.md

@@ -0,0 +1,88 @@
+[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/quality-score.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/?branch=v1) [![Code Coverage](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/coverage.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/?branch=v1) [![Build Status](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/build.png?b=v1)](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/build-status/v1) [![Code Intelligence Status](https://scrutinizer-ci.com/g/nystudio107/craft-twigprofiler/badges/code-intelligence.svg?b=v1)](https://scrutinizer-ci.com/code-intelligence)
+
+# Twig Profiler plugin for Craft CMS 3.x
+
+Twig Profiler allows you to profile sections of your Twig templates, and see the resulting timings in the Yii2 Debug Toolbar
+
+![Screenshot](./resources/img/plugin-logo.png)
+
+## Requirements
+
+This plugin requires Craft CMS 3.0.0 or later.
+
+## Installation
+
+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 nystudio107/craft-twigprofiler
+
+3. Install the plugin via `./craft install/plugin twig-profiler` via the CLI, or in the Control Panel, go to Settings → Plugins and click the “Install” button for Twig Profiler.
+
+Or you can install the plugin via the **Plugin Store** in the Craft CMS 3 Control Panel.
+
+## Twig Profiler Overview
+
+Twig Profiler lets you record profiling information on chunks of your Twig template code, so you can see how long it takes to execute.
+
+## Configuring Twig Profiler
+
+To use Twig Profiler, you'll need to enable the [Yii2 Debug Toolbar](https://yii2-framework.readthedocs.io/en/stable/guide/tool-debugger/), since it's what is used to display the profile information.
+
+![Screenshot](./resources/screenshots/enable-debug-toolbar.png)
+
+To enable it, go to the your Account page, and click on the **Preferences** tab. Then check the **Show the debug toolbar on the front end** and/or **Show the debug toolbar on the Control Panel** checkboxes, depending on where you want the toolbar to appear.
+
+You'll then have the Debug Toolbar appearing at the bottom of your pages:
+
+![Screenshot](./resources/screenshots/debug-toolbar.png)
+
+If you want to learn more about the Debug Toolbar, check out the [Profiling your Website with Craft CMS 3’s Debug Toolbar](https://nystudio107.com/blog/profiling-your-website-with-craft-cms-3s-debug-toolbar) article.
+
+## Using Twig Profiler
+
+### Quick Overview
+
+To use Twig Profiler, just wrap any chunks of Twig code you like in:
+
+```twig
+{% profile "woof" %}
+    {# code goes here #}
+{% endprofile %}
+```
+The parameter you pass in (`woof` in the above example) should be unique per profile block, so you can identity it when looking at the profiling data.
+
+Reload your page, and then click on the **Time** section of the Debug Toolbar, and you'll see your profile data:
+
+![Screenshot](./resources/screenshots/performance-profiling.png)
+
+The **Duration** column shows how long it took to execute the chunk of code inside of the `{% profile %}` block.
+
+The **Category** column shows the type of the profile sample, which will always been **Twig Profiler** along with the name of the template, for profile data collected by Twig Profiler.
+
+The **Info** column shows the unique identifier we passed in.
+
+You can filter the display to show only the **Category** or **Info** you want by typing into the text boxes above the columns.
+
+Clicking on the **Timeline** section on the left will show you a visual timeline of the profile data:
+
+![Screenshot](./resources/screenshots/performance-timeline.png)
+
+Hovering over the green sections will show you the **Info** identifier you passed in.
+
+### Pro Tips
+
+You can have as many `{% profile %}` block tags a page as you like, and they can wrap around any Twig code you like (`include`, `block`, whatever).
+
+You can nest `{% profile %}` block tags as much as you like.
+
+Profile data is only collected when `devMode` is on. If you turn `devMode` off, the `{% profile %}` block tags do nothing, so you can safely leave them in your production code.
+
+Under the hood, it uses the exact same method that Craft/Yii2 use to record profiling data.
+
+Brought to you by [nystudio107](https://nystudio107.com/)