Initial commit

CHANGELOG.md

@@ -0,0 +1,5 @@
+# v1.0.0
+## 02/24/2018
+
+1. [](#new)
+    * ChangeLog started...

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tim Robertson
+
+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

@@ -0,0 +1,33 @@
+# Grav Markdown Task Lists Plugin
+
+The **markdown-tasklists plugin** for [Grav](http://github.com/getgrav/grav) allows generation of task lists via markdown:
+
+![](assets/screenshot.png)
+
+# Installation
+
+This plugin is easy to install with GPM.
+
+```
+$ bin/gpm install markdown-tasklists
+```
+
+# Configuration
+
+Simply copy the `user/plugins/markdown-tasklists/markdown-tasklists.yaml` into `user/config/plugins/markdown-tasklists.yaml` and make your modifications.
+
+```
+enabled: true
+```
+
+# Examples
+
+To create a task list, preface list items with `[ ]`. To mark a task as complete, use `[x]`.
+
+```
+- [x] Finish my changes
+- [ ] Push my commits to GitHub
+- [ ] Open a pull request
+```
+
+![](https://help.github.com/assets/images/help/writing/task-list-rendered.png)

assets/tasklists.css

@@ -0,0 +1,9 @@
+
+.task-list-item {
+	list-style-type: none;
+}
+
+.task-list-item-checkbox {
+    margin: 0 0.2em 0.25em -1.6em;
+    vertical-align: middle;
+}

blueprints.yaml

@@ -0,0 +1,25 @@
+name: Markdown Task Lists
+version: 1.0.0
+description: "Adds the ability to render task lists in Markdown"
+icon: asterisk
+author:
+  name: Tim Robertson
+  url: https://funkjedi.com
+homepage: https://github.com/funkjedi/grav-plugin-markdown-tasklists
+keywords: markdown
+bugs: https://github.com/funkjedi/grav-plugin-markdown-tasklists/issues
+license: MIT
+
+form:
+  validation: strict
+  fields:
+    enabled:
+      type: toggle
+      label: Plugin status
+      highlight: 1
+      default: 0
+      options:
+        1: Enabled
+        0: Disabled
+      validate:
+        type: bool

markdown-tasklists.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Grav\Plugin;
+
+use Grav\Common\Plugin;
+use RocketTheme\Toolbox\Event\Event;
+
+class MarkdownTaskListsPlugin extends Plugin
+{
+    /**
+     * @return array
+     */
+    public static function getSubscribedEvents()
+    {
+        return [
+            'onMarkdownInitialized' => ['onMarkdownInitialized', 0],
+            'onTwigSiteVariables'   => ['onTwigSiteVariables', 0]
+        ];
+    }
+
+    public function onMarkdownInitialized(Event $event)
+    {
+        $markdown = $event['markdown'];
+
+        $markdown->addBlockType('-', 'List', false, true);
+
+        $markdown->blockListComplete = function(array $Block) {
+            if ($Block['pattern'] === '[*+-]') {
+                $containsTaskList = false;
+                foreach ($Block['element']['text'] as &$Item) {
+                    foreach ($Item['text'] as &$Text) {
+                        $prefix = substr(trim($Text), 0, 4);
+                        if ($prefix === '[ ] ' || $prefix === '[x] ') {
+                            $containsTaskList = true;
+                            $Item['attributes'] = ['class' => 'task-list-item'];
+                            $Text = sprintf(
+                                '<input class="task-list-item-checkbox" type="checkbox" %s> %s',
+                                $prefix === '[x] ' ? 'checked disabled' : 'disabled',
+                                substr(trim($Text), 4)
+                            );
+                        }
+                    }
+                }
+                if ($containsTaskList) {
+                    $Block['element']['attributes'] = ['class' => 'contains-task-list'];
+                }
+            }
+            return $Block;
+        };
+    }
+
+    public function onTwigSiteVariables()
+    {
+        $this->grav['assets']->add('plugin://markdown-tasklists/assets/tasklists.css');
+    }
+}

markdown-tasklists.yaml

@@ -0,0 +1 @@
+enabled: true