From 7dbb4bbaffb815cbc1672a0962e14e38bf121bd8 Mon Sep 17 00:00:00 2001 From: Caen De Silva Date: Fri, 2 Feb 2024 20:30:48 +0100 Subject: [PATCH] Merge downstream UI Kit documentation --- .../{ => _pages}/components-demo.blade.php | 6 +- .../{ => _pages}/layout-demos/focus.blade.php | 5 ++ .../layout-demos/sidegrid.blade.php | 6 ++ packages/ui-kit/docs/composer.json | 70 +++++++++++++++++++ packages/ui-kit/docs/documentation.md | 9 ++- 5 files changed, 90 insertions(+), 6 deletions(-) rename packages/ui-kit/docs/{ => _pages}/components-demo.blade.php (87%) rename packages/ui-kit/docs/{ => _pages}/layout-demos/focus.blade.php (86%) rename packages/ui-kit/docs/{ => _pages}/layout-demos/sidegrid.blade.php (84%) create mode 100644 packages/ui-kit/docs/composer.json diff --git a/packages/ui-kit/docs/components-demo.blade.php b/packages/ui-kit/docs/_pages/components-demo.blade.php similarity index 87% rename from packages/ui-kit/docs/components-demo.blade.php rename to packages/ui-kit/docs/_pages/components-demo.blade.php index 931675a7da1..f54237bc780 100644 --- a/packages/ui-kit/docs/components-demo.blade.php +++ b/packages/ui-kit/docs/_pages/components-demo.blade.php @@ -1,5 +1,5 @@ - + @@ -18,12 +18,12 @@
- @include('ui-examples.components') + @include('components')
- @include('ui-examples.components') + @include('components')
diff --git a/packages/ui-kit/docs/layout-demos/focus.blade.php b/packages/ui-kit/docs/_pages/layout-demos/focus.blade.php similarity index 86% rename from packages/ui-kit/docs/layout-demos/focus.blade.php rename to packages/ui-kit/docs/_pages/layout-demos/focus.blade.php index cb7688a17d5..aff40adee3e 100644 --- a/packages/ui-kit/docs/layout-demos/focus.blade.php +++ b/packages/ui-kit/docs/_pages/layout-demos/focus.blade.php @@ -5,6 +5,7 @@ display: flex; align-items: center; justify-content: center; + flex-direction: column; background: #80808080; position: relative; } @@ -19,11 +20,15 @@ width: 100%; height: 4rem; } + .contentArea p { + margin-top: 0.25rem; + }
Content Area +

(Focus Layout)

 diff --git a/packages/ui-kit/docs/layout-demos/sidegrid.blade.php b/packages/ui-kit/docs/_pages/layout-demos/sidegrid.blade.php similarity index 84% rename from packages/ui-kit/docs/layout-demos/sidegrid.blade.php rename to packages/ui-kit/docs/_pages/layout-demos/sidegrid.blade.php index 48d7b6910b3..aac098de4ab 100644 --- a/packages/ui-kit/docs/layout-demos/sidegrid.blade.php +++ b/packages/ui-kit/docs/_pages/layout-demos/sidegrid.blade.php @@ -5,6 +5,7 @@ display: flex; align-items: center; justify-content: center; + flex-direction: column; background: #80808080; position: relative; } @@ -19,12 +20,16 @@ width: 100%; height: 4rem; } + .contentArea p { + margin-top: 0.25rem; + }
Content Area +

(Sidegrid Layout)

@@ -32,6 +37,7 @@ Content Area +

(Sidegrid Layout - Aside)

 diff --git a/packages/ui-kit/docs/composer.json b/packages/ui-kit/docs/composer.json new file mode 100644 index 00000000000..1100f569399 --- /dev/null +++ b/packages/ui-kit/docs/composer.json @@ -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": "caen@desilva.se" + } + ], + "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" + ] +} \ No newline at end of file diff --git a/packages/ui-kit/docs/documentation.md b/packages/ui-kit/docs/documentation.md index 660d42333c1..373e1449637 100644 --- a/packages/ui-kit/docs/documentation.md +++ b/packages/ui-kit/docs/documentation.md @@ -1,4 +1,8 @@ -# 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 @@ -10,7 +14,6 @@ Please make sure you're familiar with [Laravel Blade](https://laravel.com/docs/b >info Tip: Most components allow you to pass any additional HTML attributes to the element! - ## Components ### Buttons @@ -116,7 +119,7 @@ This component will convert any Markdown within it to HTML using the Hyde Markdo ```blade ## Markdown Heading - + Hello world! ```