Update to Hyde v0.2.1-alpha

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '20 2 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/tests.yml

@@ -0,0 +1,21 @@
+name: Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  laravel-tests:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: shivammathur/setup-php@15c43e89cdef867065b0213be354c2841860869e
+      with:
+        php-version: '8.0'
+    - uses: actions/checkout@v2
+    - name: Install Dependencies
+      run: composer install -q --no-ansi --no-interaction --no-scripts --no-progress --prefer-dist
+    - name: Execute tests (Unit and Feature tests) via PHPUnit/Pest
+      run: php hyde test

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+All notable changes to `Hyde` will be documented in this file.
+
+Once the package is tested to ensure it is stable enough for production semantic versioning (SemVer) will be used.
+Until then there may be breaking changes on the Master branch.

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Caen De Silva
+
+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.

SECURITY.md

@@ -0,0 +1,23 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          | Notes         |
+| ------- | ------------------ | ----          |
+| 0.1.0-Pre    | :warning:     | Pre-release   |
+| 0.1.0        | :x:           | Alpha-release |
+
+:warning: Pre-releases are not suited for production.
+
+<!-- 
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                | -->
+
+
+## Reporting a Vulnerability
+
+If you discover a security vulnerability within this package, please send an e-mail to the creator, Caen De Silva, via caen@desilva.se.
+
+All security vulnerabilities will be promptly addressed.

_docs/customization.md

@@ -0,0 +1,136 @@
+# Customizing your Site
+
+<p class="lead">
+Hyde favours <a href="https://en.wikipedia.org/wiki/Convention_over_configuration">"Convention over Configuration"</a>
+and thus comes preconfigured with sensible defaults. However, Hyde also strives to be modular and endlessly customizable hackable if you need it. This page guides you through the endless options available!
+</p>
+
+## Main Configuration File
+The main configuration file is in `config/hyde.php`. The [config file](https://github.com/hydephp/hyde/blob/master/config/hyde.php) is fully documented so I recommend you take a look to see all the options.
+
+In this config file, you can customize the site name, what modules to enable, and programmatically customize the navigation menu and documentation sidebar. 
+
+Here are a few examples of the config options.
+
+### Modules
+With a concept directly inspired by [Laravel Jetstream](https://jetstream.laravel.com/), this setting allows you to toggle various modules.
+```php
+// torchlight! {"lineNumbers": false}
+'features' => [
+    Features::blogPosts(),
+    Features::bladePages(),
+    Features::markdownPages(),
+    // Features::documentationPages(),
+],
+```
+
+### Footer
+The footer can be customized using Markdown, and even disabled completely.
+
+```php
+// torchlight! {"lineNumbers": false}
+'footer' => [
+  'enabled' => true,
+  'markdown' => 'Site built with [HydePHP](https://github.com/hydephp/hyde).'
+],
+```
+
+### Navigation Menu & Sidebar
+One of my (the author's) favourite features with Hyde is its automatic navigation menu and documentation sidebar generator.
+
+#### How it works:
+The sidebar works by creating a list of all the documentation pages.
+
+The navigation menu is a bit more sophisticated, it adds all the top-level Blade and Markdown pages. It also adds an automatic link to the docs if there is an `index.md` or `readme.md` in the `_docs` directory.
+
+#### Reordering Items
+Sadly, Hyde is not intelligent enough to determine what order items should be in (blame Dr Jekyll for this), so you will probably want to set a custom order.
+
+Reordering items in the documentation sidebar is as easy as can be. In the hyde config, there is an array just for this. When the sidebar is generated it looks through this config array. If a slug is found here they will get the priority according to their position in the list. If a page does not exist in the list they get the priority 999, which puts them last.
+
+Let's see an example:
+```php
+// torchlight! {"lineNumbers": false}
+// This is the default values in the config. It puts the readme.md first in order.
+'documentationPageOrder' => [
+    'readme', // This is the first entry, so it gets the priority 0
+    'installation', // This gets priority 1
+    'getting-started', // And this gets priority 2
+    // Any other pages not listed will get priority 999 
+]
+```
+
+> Navigation menu items will be ordered in the same way in a coming update, but for now, they can be reordered by overriding them which you can learn in the next section.
+
+#### Adding Custom Navigation Menu Links
+> Until the navigation link order is implemented, you can use this feature to reorder navigation menu items.
+
+The links are added in the config/hyde.php file, and the syntax for adding custom links is documented in the config. Here are some examples:
+
+```php
+// torchlight! {"lineNumbers": false}
+// External link
+[
+    'title' => 'GitHub',
+    'destination' => 'https://github.com/hydephp/hyde',
+    'priority' => 1200,
+],
+
+// Internal link (Hyde automatically resolves relative paths)
+[
+    'title' => 'Featured Blog Post',
+    'slug' => 'posts/hello-world',
+    // The 'priority' is not required.
+]
+```
+
+#### Removing Items (Blacklist)
+
+Sometimes, especially if you have a lot of pages, you may want to prevent links from showing up in the main navigation menu. To remove items from being automatically added, simply add the slug to the blacklist. As you can see, the `404` page has already been filled in for you.
+
+```php
+'navigationMenuBlacklist' => [
+    '404'
+],
+```
+
+> Tip: You can publish the included 404 page using `php hyde publish:404`!
+
+## Blade Views
+Hyde uses the Laravel templating system called Blade. Most parts have been extracted into components to be customized easily. Here is an overview.
+
+> Before editing Blade views you should familiarize yourself with how they work in the official documentation https://laravel.com/docs/9.x/blade.
+
+
+All blade views are located in the `resources/views` directory.
+### Directory Overview
+```bash
+resources/views/ # [tl! reindex(null)]
+├── components # Contains components to be included in parent layouts
+│   ├── article-excerpt.blade.php
+│   ├── docs # Contains components specific to the Documentation pages
+│   │   ├── content.blade.php
+│   │   ├── navigation.blade.php
+│   │   ├── sidebar-footer.blade.php
+│   │   ├── sidebar-header.blade.php
+│   │   ├── sidebar-toggle.blade.php
+│   │   └── sidebar.blade.php
+│   └── post # Contains components specific to the Blog post pages
+│       ├── article.blade.php
+│       ├── author.blade.php
+│       ├── category.blade.php
+│       ├── datePublished.blade.php
+│       └── description.blade.php
+├── layouts # Contains components used for layouts
+│   ├── app.blade.php
+│   ├── footer.blade.php
+│   ├── meta.blade.php
+│   └── navigation.blade.php
+├── pages # Contains custom Blade pages*
+│   └── index.blade.php
+├── page.blade.php
+├── docs.blade.php
+└── post.blade.php
+```
+
+*See [Getting Started](getting-started.html#hyde-pages-using-blade) for more details on creating custom Blade pages.

_site/docs/console-commands.html

@@ -15,7 +15,7 @@
 
         <!-- Include any extra tags to include in the <head> section -->
     </head>
-    <body id="app" class="overflow-x-hidden">
+    <body id="app" class="flex flex-col min-h-screen overflow-x-hidden">
         <section id="content">
             <nav
                 id="documentation-navigation"
@@ -111,6 +111,13 @@ <h2 class="font-bold opacity-75 hover:opacity-100 w-fit">
                                 >Console Commands</a
                             >
                         </li>
+                        <li class="py-2 list-item">
+                            <a
+                                href="customization.html"
+                                class="hover:text-indigo-500"
+                                >Customization</a
+                            >
+                        </li>
                     </ul>
                 </nav>
                 <footer class="p-4 mt-auto border-t">
@@ -288,11 +295,69 @@ <h2>
                                 >http://localhost:3000/</a
                             >.
                         </p>
+                        <p class="mt-8">
+                            <i>
+                                Syntax highlighting by
+                                <a
+                                    href="https://torchlight.dev/"
+                                    rel="noopener nofollow"
+                                    >Torchlight.dev</a
+                                >
+                            </i>
+                        </p>
                     </div>
                 </article>
             </main>
 
-            <script defer src="../media/docs.js"></script>
+            <script>
+                var sidebarOpen = screen.width >= 768;
+
+                const sidebar = document.getElementById(
+                    "documentation-sidebar"
+                );
+                const main = document.getElementById("documentation-content");
+                const backdrop = document.getElementById("sidebar-backdrop");
+
+                const toggleButtons = document.querySelectorAll(
+                    ".sidebar-button-wrapper"
+                );
+
+                function toggleSidebar() {
+                    if (sidebarOpen) {
+                        hideSidebar();
+                    } else {
+                        showSidebar();
+                    }
+                }
+
+                function showSidebar() {
+                    sidebar.classList.remove("hidden");
+                    sidebar.classList.add("flex");
+                    backdrop.classList.remove("hidden");
+                    document.getElementById("app").style.overflow = "hidden";
+
+                    toggleButtons.forEach((button) => {
+                        button.classList.remove("open");
+                        button.classList.add("closed");
+                    });
+
+                    sidebarOpen = true;
+                }
+
+                function hideSidebar() {
+                    sidebar.classList.add("hidden");
+                    sidebar.classList.remove("flex");
+                    backdrop.classList.add("hidden");
+                    document.getElementById("app").style.overflow = null;
+
+                    toggleButtons.forEach((button) => {
+                        button.classList.add("open");
+                        button.classList.remove("closed");
+                    });
+
+                    sidebarOpen = false;
+                }
+            </script>
             <div
                 id="sidebar-backdrop"
                 class="hidden"