Skip to content

Commit

Permalink
Merge branch 'master' into compile-hydefront
Browse files Browse the repository at this point in the history
  • Loading branch information
caendesilva authored Feb 4, 2024
2 parents 38133b2 + a1394f2 commit 9db921f
Show file tree
Hide file tree
Showing 7 changed files with 111 additions and 9 deletions.
9 changes: 9 additions & 0 deletions docs/extensions/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,15 @@ as well as support for third-party extensions and integrations.
The Hyde Realtime Compiler is included with Hyde installations and is what powers the `php hyde serve` command.
- Learn more about the [Realtime Compiler](realtime-compiler) in the documentation.

### UI Kit

The [HydePHP UI Kit](https://github.com/hydephp/ui-kit) is a set of minimalistic Blade & Tailwind components to kickstart development of custom Blade views for your HydePHP site.
- Learn more at https://github.com/hydephp/ui-kit and see the documentation at https://hydephp.github.io/ui-kit

### GitHub Action

The [GitHub Action for HydePHP](https://github.com/hydephp/action) is hands-down the easiest way to build and deploy your Hyde site to GitHub Pages.
- Learn more at https://github.com/hydephp/action and see the documentation at https://hydephp.github.io/action

## Integrations with third-party tools

Expand Down
1 change: 0 additions & 1 deletion packages/ui-kit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ composer require hyde/ui-kit

Since HydePHP already comes with several built-in views and templates, including a precompiled CSS file to get you started quickly, this package is not required to use HydePHP and is tailored to intermediate-to-advanced users, giving you an excellent productivity boost in kick-starting development of any custom Blade pages.


## Usage

Once installed, the package service provider will automatically register the Blade components for you to use.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html lang="{{ config('hyde.language', 'en') }}">
<html lang="{{ config('site.language', 'en') }}">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
Expand All @@ -18,12 +18,12 @@
<div class="flex">
<div class="light">
<div class="dark:bg-gray-900 dark:text-white w-[70ch] p-8 border-gray-500 border-r-gray-900 border-2">
@include('ui-examples.components')
@include('components')
</div>
</div>
<div class="dark">
<div class="dark:bg-gray-900 dark:text-white w-[70ch] p-8 border-gray-900 border-2">
@include('ui-examples.components')
@include('components')
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
display: flex;
align-items: center;
justify-content: center;
flex-direction: column;
background: #80808080;
position: relative;
}
Expand All @@ -19,11 +20,15 @@
width: 100%;
height: 4rem;
}
.contentArea p {
margin-top: 0.25rem;
}
</style>
<x-hyde-ui::layouts.focus>
<div id="contentArea">
<x-hyde-ui::heading>
Content Area
</x-hyde-ui::heading>
<p>(Focus Layout)</p>
</div>
</x-hyde-ui::layouts.focus>
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
display: flex;
align-items: center;
justify-content: center;
flex-direction: column;
background: #80808080;
position: relative;
}
Expand All @@ -19,19 +20,24 @@
width: 100%;
height: 4rem;
}
.contentArea p {
margin-top: 0.25rem;
}
</style>
<x-hyde-ui::layouts.sidegrid>
<div class="contentArea">
<x-hyde-ui::heading>
Content Area
</x-hyde-ui::heading>
<p>(Sidegrid Layout)</p>
</div>

<x-slot:aside>
<div class="contentArea">
<x-hyde-ui::heading>
Content Area
</x-hyde-ui::heading>
<p>(Sidegrid Layout - Aside)</p>
</div>
</x-slot:aside>
</x-hyde-ui::layouts.sidegrid>
70 changes: 70 additions & 0 deletions packages/ui-kit/docs/composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
{
"name": "hyde/hyde",
"description": "Static Site Generator to rapidly create Blogs, Documentation Sites, and more, using Markdown and Blade.",
"keywords": [
"framework",
"hyde",
"hyde framework",
"hydephp",
"static site generator",
"static site framework",
"ssg"
],
"homepage": "https://hydephp.com",
"type": "project",
"license": "MIT",
"support": {
"issues": "https://github.com/hydephp/hyde/issues",
"source": "https://github.com/hydephp/hyde"
},
"authors": [
{
"name": "Caen De Silva",
"email": "[email protected]"
}
],
"require": {
"php": "^8.1",
"hyde/framework": "^1.0",
"hyde/ui-kit": "dev-master",
"laravel-zero/framework": "^10.0"
},
"require-dev": {
"hyde/realtime-compiler": "^3.0"
},
"autoload": {
"psr-4": {
"App\\": "app/"
}
},
"autoload-dev": {
"psr-4": {
"Hyde\\Testing\\": "tests/"
}
},
"scripts": {
"post-autoload-dump": [
"@php -r \"@unlink('./app/storage/framework/cache/packages.php');\"",
"@php hyde package:discover --ansi"
]
},
"config": {
"preferred-install": "dist",
"sort-packages": true,
"optimize-autoloader": true,
"allow-plugins": {
"pestphp/pest-plugin": true
}
},
"repositories": [
{
"type": "vcs",
"url": "https://github.com/hydephp/ui-kit"
}
],
"minimum-stability": "dev",
"prefer-stable": true,
"bin": [
"hyde"
]
}
23 changes: 18 additions & 5 deletions packages/ui-kit/docs/documentation.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
# Hyde UI Kit - Documentation
---
title: Documentation
---

# HydePHP UI Kit - Documentation

The HydePHP UI Kit is a collection of minimalistic and un-opinionated TailwindCSS components for Laravel Blade,
indented to be used with HydePHP. Note that these components may require CSS classes not present in the bundled app.css
file and that you may need to recompile the CSS file using the included Laravel Mix configuration.

## Preface

Please make sure you're familiar with [Laravel Blade](https://laravel.com/docs/blade) before using the HydePHP UI Kit.
## Screenshot

>info Tip: Most components allow you to pass any additional HTML attributes to the element!
Here are some of the components you can use to build your next project! As you can see, all components support both light and dark mode out of the box, just like the rest of HydePHP.

![Components Screenshot](https://raw.githubusercontent.com/hydephp/ui-kit/art/header-large-min.png)

## Components

Please make sure you're familiar with [Laravel Blade](https://laravel.com/docs/blade) before using the HydePHP UI Kit.

>info Tip: Most components allow you to pass any additional HTML attributes to the element!
### Buttons

#### Primary
Expand Down Expand Up @@ -153,3 +160,9 @@ You can get surprisingly far when you combine the components. Take this newslett
</x-slot>
</x-hyde-ui::card>
```

![Newsletter Screenshot](https://raw.githubusercontent.com/hydephp/ui-kit/art/newsletter-signup-example-min.png)

## GitHub Repository

You can find the source code for the UI Kit on GitHub at [hydephp/ui-kit](https://github.com/hydephp/ui-kit).

0 comments on commit 9db921f

Please sign in to comment.