Skip to content

Commit

Permalink
Format Markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
caendesilva committed Feb 10, 2024
1 parent c379824 commit 5aade5f
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 5 deletions.
1 change: 0 additions & 1 deletion .github/workflows/hyde-stan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,3 @@ jobs:

- name: Run HydeFront linter
run: php packages/hydefront/.github/scripts/post-build.php

3 changes: 2 additions & 1 deletion docs/architecture-concepts/the-hydekernel.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The HydeKernel is stored as a singleton in a static property in its own class an
Commonly, you'll use the `Hyde` facade which forwards calls to the singleton instance.
You can also use the `hyde()` function to get the Kernel, and call methods on it.

Since the instance is also bound into the Laravel Application Service Container you can also use Dependency Injection by type-hinting the `HydeKernel::class`.
Since the instance is also bound into the Laravel Application Service Container you can also use Dependency Injection by type-hinting the `HydeKernel::class`.

Here are some examples of how you can call methods on the Kernel. All methods call the same method on the same instance, so it's just a matter of preference.

Expand All @@ -43,6 +43,7 @@ hyde()->version();

The Kernel instance is constructed in `bootstrap.php`, and is available globally as `$hyde`.


## The kernel lifecycle

Whenever we talk about the kernel being "booted" we are talking about the kernel's role in the autodiscovery process.
Expand Down
4 changes: 2 additions & 2 deletions docs/digging-deeper/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -365,12 +365,12 @@ For example: `_docs/getting-started/installation.md` will be placed in a group c

## Additional Advanced Options

The following configuration options in the `confg/hyde.php` file are intended for advanced users and
The following configuration options in the `confg/hyde.php` file are intended for advanced users and
should only be modified if you fully understand their impact. The code examples show the default values.

### `media_extensions`

This option allows you to specify file extensions considered as media files, which will be copied to the output directory.
This option allows you to specify file extensions considered as media files, which will be copied to the output directory.
To add more extensions, either append them to the existing array or override the entire array.

```php
Expand Down
4 changes: 3 additions & 1 deletion docs/digging-deeper/updating-hyde.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ This guide will help you update your HydePHP project to the latest version.
When updating an existing installation, first ensure that you have a backup of your project in case anything goes wrong.
The recommended way to do this is to use Git as that allows you to smoothly roll back any changes.


## Version compatibility

HydePHP follows [semantic versioning](https://semver.org/), so you can expect that minor and patch releases will be backwards compatible.
Expand All @@ -27,11 +28,12 @@ hence why version controlling your site is helpful when updating versions as you
be helpful to version control the compiled HTML, so you can view a diff of the changes. Be sure to test that your site
can be built and that it looks as expected after updating before deploying the changes to your live site.

We of course have extensive tests in place run on each single code commit to ensure all code is functional, however,
We of course have extensive tests in place run on each single code commit to ensure all code is functional, however,
it is still possible that some edge cases slip through. This means that a bug fix may impact an edge case that you depend on.

Obligatory related XKCD: [https://xkcd.com/1172](https://xkcd.com/1172)


## Methods

### Which method?
Expand Down
1 change: 1 addition & 0 deletions docs/extensions/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ The [HydePHP UI Kit](https://github.com/hydephp/ui-kit) is a set of minimalistic
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

### Torchlight
Expand Down
3 changes: 3 additions & 0 deletions docs/extensions/ui-kit.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@ The HydePHP UI Kit is a collection of minimalistic and un-opinionated TailwindCS
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.


## Screenshot

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.
Expand Down Expand Up @@ -159,6 +161,7 @@ You can get surprisingly far when you combine the components. Take this newslett

![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 5aade5f

Please sign in to comment.