Add MkDocs-Material (#142)

* add mkdocs

* add docs workflow

* add publish command

* cs fix

* remove toc for installation

Author: michalsn

.github/workflows/docs.yml

@@ -0,0 +1,23 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - develop
+    paths:
+      - 'docs/*'
+      - 'mkdocs.yml'
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material
+      - run: mkdocs gh-deploy --force

docs/assets/css/codeigniter.css

@@ -0,0 +1,18 @@
+[data-md-color-scheme="codeigniter"] {
+    --md-primary-fg-color:        #dd4814;
+    --md-primary-fg-color--light: #ECB7B7;
+    --md-primary-fg-color--dark:  #90030C;
+
+    --md-default-bg-color: #fcfcfc;
+
+    --md-typeset-a-color: #e74c3c;
+    --md-accent-fg-color: #97310e;
+
+    --md-accent-fg-color--transparent: #ECB7B7;
+
+    --md-code-bg-color: #ffffff;
+
+    .md-typeset code {
+        border: 1px solid #e1e4e5;
+    }
+}

docs/assets/css/codeigniter_dark_mode.css

@@ -0,0 +1,71 @@
+[data-md-color-scheme="slate"] {
+    --md-primary-fg-color: #b13a10;
+    --md-primary-fg-color--light: #8d7474;
+    --md-primary-fg-color--dark: #6d554d;
+
+    --md-default-bg-color: #1e2129;
+
+    --md-typeset-a-color: #ed6436;
+    --md-accent-fg-color: #f18a67;
+
+    --md-accent-fg-color--transparent: #625151;
+
+    --md-code-bg-color: #282b2d;
+
+    .hljs-title,
+    .hljs-title.class_,
+    .hljs-title.class_.inherited__,
+    .hljs-title.function_ {
+        color: #c9a69b;
+    }
+
+    .hljs-meta .hljs-string,
+    .hljs-regexp,
+    .hljs-string {
+        color: #a3b4c7;
+    }
+
+    .hljs-attr,
+    .hljs-attribute,
+    .hljs-literal,
+    .hljs-meta,
+    .hljs-number,
+    .hljs-operator,
+    .hljs-selector-attr,
+    .hljs-selector-class,
+    .hljs-selector-id,
+    .hljs-variable {
+        color: #c1b79f;
+    }
+
+    .hljs-doctag,
+    .hljs-keyword,
+    .hljs-meta .hljs-keyword,
+    .hljs-template-tag,
+    .hljs-template-variable,
+    .hljs-type,
+    .hljs-variable.language_ {
+        color: #c97100;
+    }
+
+    .hljs-subst {
+        color: #ddba52
+    }
+
+    .md-typeset code {
+        border: 1px solid #3f4547;
+    }
+
+    .md-typeset .admonition.note,
+    .md-typeset details.note {
+        border-color: #2c5293;
+    }
+
+    .md-typeset .note > .admonition-title:before,
+    .md-typeset .note > summary:before {
+        background-color: #2c5293;
+        -webkit-mask-image: var(--md-admonition-icon--note);
+        mask-image: var(--md-admonition-icon--note);
+    }
+
+}

docs/assets/favicon.ico

@@ -0,0 +1,3 @@
+document.addEventListener('DOMContentLoaded', (event) => {
+    hljs.highlightAll();
+});

docs/assets/flame.svg

@@ -0,0 +1,138 @@
+# Basic Usage
+
+Tasks are configured with the `app/Config/Tasks.php` config file, inside the `init()` method.
+Let's start with a simple example:
+
+```php
+<?php
+
+namespace Config;
+
+use CodeIgniter\Tasks\Config\Tasks as BaseTasks;
+use CodeIgniter\Tasks\Scheduler;
+
+class Tasks extends BaseTasks
+{
+    /**
+     * Register any tasks within this method for the application.
+     *
+     * @param Scheduler $schedule
+     */
+    public function init(Scheduler $schedule)
+    {
+        $schedule->call(function() {
+            DemoContent::refresh();
+        })->mondays();
+    }
+}
+```
+
+In this example, we use a closure to refresh demo content at 12:00 am every Monday morning. Closures are
+a simple way to handle quick functions like this. You can also execute server commands, execute custom
+CLI commands you have written, call a URL, or even fire off an Event of your choosing. Details are covered
+below.
+
+## Scheduling
+
+This is how we can schedule our tasks. We have many options.
+
+### Scheduling CLI Commands
+
+If you have written your own [CLI Commands](https://codeigniter.com/user_guide/cli/cli_commands.html), you
+can schedule them to run using the `command()` method.
+
+```php
+$schedule->command('demo:refresh --all');
+```
+
+The only argument is a string that calls the command, complete with an options or arguments.
+
+### Scheduling Shell Commands
+
+You can call out to the server and execute a command using the `shell()` method.
+
+```php
+$schedule->shell('cp foo bar')->daily()->at('11:00 pm');
+```
+
+Simply provide the command to call and any arguments, and it will be executed using PHP's `exec()` method.
+
+!!! note
+
+    Many shared servers turn off exec access for security reasons. If you will be running
+    on a shared server, double-check you can use the `exec` command before using this feature.
+
+### Scheduling Events
+
+If you want to trigger an [Event](https://codeigniter.com/user_guide/extending/events.html) you can
+use the `event()` method to do that for you, passing in the name of the event to trigger.
+
+```php
+$schedule->event('Foo')->hourly();
+```
+
+### Scheduling URL Calls
+
+If you need to ping a URL on a regular basis, you can use the `url()` method to perform a simple
+GET request using cURL to the URL you pass in. If you need more dynamism than can be provided in
+a simple URL string, you can use a closure or command instead.
+
+```php
+$schedule->url('https://my-status-cloud.com?site=foo.com')->everyFiveMinutes();
+```
+
+## Frequency Options
+
+There are a number of ways available to specify how often the task is called.
+
+
+| Method                            | Description                                                           |
+|:----------------------------------|:----------------------------------------------------------------------|
+| `->cron('* * * * *')`             | Run on a custom cron schedule.                                        |
+| `->daily('4:00 am')`              | Runs daily at 12:00am, unless a time string is passed in.             |
+| `->hourly() / ->hourly(15)`       | Runs at the top of every hour or at specified minute.                 |
+| `->everyHour(3, 15)`              | Runs every 3 hours at XX:15.                                          |
+| `->betweenHours(6,12)`            | Runs between hours 6 and 12.                                          |
+| `->hours([0,10,16])`              | Runs at hours 0, 10 and 16.                                           |
+| `->everyMinute(20)`               | Runs every 20 minutes.                                                |
+| `->betweenMinutes(0,30)`          | Runs between minutes 0 and 30.                                        |
+| `->minutes([0,20,40])`            | Runs at specific minutes 0,20 and 40.                                 |
+| `->everyFiveMinutes()`            | Runs every 5 minutes (12:00, 12:05, 12:10, etc)                       |
+| `->everyFifteenMinutes()`         | Runs every 15 minutes (12:00, 12:15, etc)                             |
+| `->everyThirtyMinutes()`          | Runs every 30 minutes (12:00, 12:30, etc)                             |
+| `->days([0,3])`                   | Runs only on Sunday and Wednesday  ( 0 is Sunday , 6 is Saturday )    |
+| `->sundays('3:15am')`             | Runs every Sunday at midnight, unless time passed in.                 |
+| `->mondays('3:15am')`             | Runs every Monday at midnight, unless time passed in.                 |
+| `->tuesdays('3:15am')`            | Runs every Tuesday at midnight, unless time passed in.                |
+| `->wednesdays('3:15am')`          | Runs every Wednesday at midnight, unless time passed in.              |
+| `->thursdays('3:15am')`           | Runs every Thursday at midnight, unless time passed in.               |
+| `->fridays('3:15am')`             | Runs every Friday at midnight, unless time passed in.                 |
+| `->saturdays('3:15am')`           | Runs every Saturday at midnight, unless time passed in.               |
+| `->monthly('12:21pm')`            | Runs the first day of every month at 12:00am unless time passed in.   |
+| `->daysOfMonth([1,15])`           | Runs only on days 1 and 15.                                           |
+| `->months([1,7])`                 | Runs only on January and July.                                        |
+| `->quarterly('5:00am')`           | Runs the first day of each quarter (Jan 1, Apr 1, July 1, Oct 1)      |
+| `->yearly('12:34am')`             | Runs the first day of the year.                                       |
+| `->weekdays('1:23pm')`            | Runs M-F at 12:00 am unless time passed in.                           |
+| `->weekends('2:34am')`            | Runs Saturday and Sunday at 12:00 am unless time passed in.           |
+| `->environments('local', 'prod')` | Restricts the task to run only in the specified environments          |
+
+
+These methods can be combined to create even more nuanced timings:
+
+```php
+$schedule->command('foo')
+    ->weekdays()
+    ->hourly()
+    ->environments('development');
+```
+
+This would run the task at the top of every hour, Monday - Friday, but only in development environments.
+
+## Naming Tasks
+
+You can name tasks so they can be easily referenced later, such as through the CLI with the `named()` method:
+
+```php
+$schedule->command('foo')->nightly()->named('foo-task');
+```

docs/assets/js/hljs.js

@@ -1,51 +1,72 @@
 # CLI Commands
 
 Included in the package are several commands that can be run from that CLI that provide that bit of emergency
-help you might need when something is going wrong with a cron job at 1am on a Saturday. 
+help you might need when something is going wrong with a cron job at 1am on a Saturday.
 
-All commands are run through CodeIgniter's `spark` cli tool: 
+## Available Commands
 
-    > php spark tasks:list
-    > php spark tasks:run
+All commands are run through CodeIgniter's `spark` cli tool.
 
-## Available Commands
+- [tasks:list](#taskslist)
+- [tasks:disable](#tasksdisable)
+- [tasks:enable](#tasksenable)
+- [tasks:run](#tasksrun)
+- [tasks:publish](#taskspublish)
 
-**tasks:list**
+### tasks:list
 
-    > php spark tasks:list
+```console
+php spark tasks:list
+```
 
 This will list all available tasks that have been defined in the project, along with their type and
 the next time they are scheduled to run.
 
     +---------------+--------------+-------------+----------+---------------------+-------------+
     | Name          | Type         | Schedule    | Last Run | Next Run            | Runs        |
     +---------------+--------------+-------------+----------+---------------------+-------------+
-    | emails        | command      | 0 0 * * *   | --       | 2020-03-21-18:30:00 | in 1 hour   |
+    | emails        | command      | 0 0 * * *   | --       | 2023-03-21-18:30:00 | in 1 hour   |
     +---------------+--------------+-------------+----------+---------------------+-------------+
 
-**tasks:disable**
+### tasks:disable
 
-    > php spark tasks:disable 
+```console
+php spark tasks:disable
+```
 
 Will disable the task runner manually until you enable it again. Stores the setting in the default
 database through the [Settings](https://github.com/codeigniter4/settings) library.
 
-**tasks:enable**
+### tasks:enable
+
+```console
+php spark tasks:enable
+```
 
-    > php spark tasks:enable
+Will enable the task runner if it was previously disabled, allowing all tasks to resume running.
 
-Will enable the task runner if it was previously disabled, allowing all tasks to resume running. 
+### tasks:run
 
-**tasks:run**
+```console
+php spark tasks:run
+```
 
-    > php spark tasks:run
-    
 This is the primary entry point to the Tasks system. It should be called by a cron task on the server
 every minute in order to be able to effectively run all the scheduled tasks. You typically will not
 run this manually.
 
 You can run the command and pass the `--task` option to immediately run a single task. This requires
-the name of the task. You can either name a task using the `->named('foo')` method when defining the 
+the name of the task. You can either name a task using the `->named('foo')` method when defining the
 schedule, or one will be automatically generated. The name can be found using `tasks:list`.
 
-    > php spark tasks:run --task emails
+```console
+php spark tasks:run --task emails
+```
+
+### tasks:publish
+
+```console
+php spark tasks:publish
+```
+
+This will publish Tasks config file into the current application.