diff --git a/config/docs.php b/config/docs.php index 4ac1dd70706..9650b1f057c 100644 --- a/config/docs.php +++ b/config/docs.php @@ -90,7 +90,7 @@ | | Example: https://github.com/hydephp/docs/blob/master | Do not specify the filename or extension, Hyde will do that for you. - | Setting the setting to null will disable the feature. + | Setting this to null will disable the feature. | */ diff --git a/config/hyde.php b/config/hyde.php index 408ababf05e..ba8757a0dc5 100644 --- a/config/hyde.php +++ b/config/hyde.php @@ -138,7 +138,7 @@ | Site Output Directory |-------------------------------------------------------------------------- | - | This setting specifies the output path for your site, useful to for + | This setting specifies the output path for your site, useful to, for | example, store the site in the docs/ directory for GitHub Pages. | The path is relative to the root of your project. | @@ -308,7 +308,7 @@ | | Here you can customize the footer Markdown text for your site. | - | If you don't want to write Markdown here, you use a Markdown include. + | If you don't want to write Markdown here, you can use a Markdown include. | You can also customize the Blade view if you want a more complex footer. | You can disable it completely by changing the setting to `false`. | @@ -428,7 +428,7 @@ | | Here you can configure settings for the built-in realtime compiler server. | The server also includes a magic dashboard feature that supercharges - | your local development! This feature can alo be customised here. + | your local development! This feature can also be customised here. | */ diff --git a/config/markdown.php b/config/markdown.php index cd9afdea0e5..b872c1a739e 100644 --- a/config/markdown.php +++ b/config/markdown.php @@ -71,7 +71,7 @@ | | This feature allows you to use basic Laravel Blade in Markdown files. | - | It's disabled by default since can be a security risk as it allows + | It's disabled by default since it can be a security risk as it allows | arbitrary PHP to run. But if your Markdown is trusted, try it out! | | To see the syntax and usage, see the documentation: diff --git a/docs/architecture-concepts/automatic-routing.md b/docs/architecture-concepts/automatic-routing.md index b4b2ac221d8..288323a5b8e 100644 --- a/docs/architecture-concepts/automatic-routing.md +++ b/docs/architecture-concepts/automatic-routing.md @@ -1,4 +1,4 @@ -## Automatic Routing +# Automatic Routing >info This covers an intermediate topic which is not required for basic usage, but is useful if you want to use the framework to design custom Blade templates. @@ -57,7 +57,7 @@ But where it really shines is when you supply a route. This will then resolve th Home ``` -You can of course, also supply extra attributes like classes: +You can also supply extra attributes like classes: ```blade Home diff --git a/docs/creating-content/blog-posts.md b/docs/creating-content/blog-posts.md index 23b19eedc8c..c4732157bbf 100644 --- a/docs/creating-content/blog-posts.md +++ b/docs/creating-content/blog-posts.md @@ -205,7 +205,7 @@ image: image.jpg #### Full URL -Full URL starting with `http(s)://`) or `//` (protocol-relative). +Full URL starting with `http(s)://` or `//` (protocol-relative). The image source will be used as-is, and no additional processing is done. ```yaml diff --git a/docs/creating-content/documentation-pages.md b/docs/creating-content/documentation-pages.md index 35419a27bdb..54d14fb3180 100644 --- a/docs/creating-content/documentation-pages.md +++ b/docs/creating-content/documentation-pages.md @@ -14,7 +14,7 @@ Hyde compiles your Markdown content into beautiful static HTML pages using a Tai Additionally, if you have an `_docs/index.md` file, the sidebar header will link to it, and an automatically generated "Docs" link will be added to your site's main navigation menu, pointing to your documentation page. -If you have a Torchlight API token in your `.env` file, Hyde will even enable syntax highlighting automatically, saving you time and effort. For more information about this feature, see the [extensions page](extensions#torchlight). +If you have a Torchlight API token in your `.env` file, Hyde will even enable syntax highlighting automatically, saving you time and effort. For more information about this feature, see the [extensions page](third-party-integrations#torchlight). ### Best Practices and Hyde Expectations @@ -241,14 +241,14 @@ To quickly arrange the order of items in the sidebar, you can reorder the page i ] ``` -See [the chapter in the customization page](customization#navigation-menu--sidebar) for more details.
+See [the chapter in the customization page](customization#navigation-menu--sidebar) for more details. ### Setting Sidebar Group Labels When using the automatic sidebar grouping feature the titles of the groups are generated from the subdirectory names. If these are not to your liking, for example if you need to use special characters, you can override them in the configuration file. The array key is the directory name, and the value is the label. ```php -// Filepath: config/docs.php +// filepath: config/docs.php 'sidebar' => [ 'labels' => [ @@ -266,7 +266,7 @@ By default, each group will be assigned the lowest priority found inside the gro Just use the sidebar group key as instead of the page identifier/route key: ```php -// Filepath: config/docs.php +// filepath: config/docs.php 'sidebar' => [ 'order' => [ 'readme', @@ -347,7 +347,7 @@ If this setting is set to true, Hyde will output all documentation pages into th If you set this to false, Hyde will match the directory structure of the source files (just like all other pages). ```php -// Filepath: config/docs.php +// filepath: config/docs.php 'flattened_output_paths' => true, ``` @@ -422,7 +422,7 @@ The feature is automatically enabled when you specify a base URL in the Docs con Here's an example configuration from the official HydePHP.com documentation: ```php -// Filepath: config/docs.php +// filepath: config/docs.php 'source_file_location_base' => 'https://github.com/hydephp/docs/blob/master/', ``` @@ -432,7 +432,7 @@ Here's an example configuration from the official HydePHP.com documentation: Changing the label is easy, just change the following config setting: ```php -// Filepath: config/docs.php +// filepath: config/docs.php 'edit_source_link_text' => 'Edit Source on GitHub', ``` @@ -441,7 +441,7 @@ Changing the label is easy, just change the following config setting: By default, the button will be shown in the documentation page footer. You can change this by setting the following config setting to `'header'`, `'footer'`, or `'both'` ```php -// Filepath: config/docs.php +// filepath: config/docs.php 'edit_source_link_position' => 'header', ``` diff --git a/docs/creating-content/static-pages.md b/docs/creating-content/static-pages.md index 8eef4a50093..1095fa5b0bc 100644 --- a/docs/creating-content/static-pages.md +++ b/docs/creating-content/static-pages.md @@ -78,8 +78,8 @@ navigation: - `label` is the text that will be displayed in the navigation menu - `priority` is the order in which the page will appear in the navigation menu (`order` is also supported) -- `hidden` will hide the page from the navigation menu (`visible`) is also supported, but obviously invert the value) -- `group` will put the page in a dropdown menu with the specified group name (`category`) is also supported) +- `hidden` will hide the page from the navigation menu (`visible` is also supported, but obviously invert the value) +- `group` will put the page in a dropdown menu with the specified group name (`category` is also supported) ## Creating Blade Pages diff --git a/docs/digging-deeper/advanced-customization.md b/docs/digging-deeper/advanced-customization.md index bcc890ba465..865daa7133c 100644 --- a/docs/digging-deeper/advanced-customization.md +++ b/docs/digging-deeper/advanced-customization.md @@ -19,7 +19,7 @@ mainly example driven, as it is assumed you have somewhat of an understanding of Each page type is represented by a page model class. Each of those classes have static properties that store the source and output directories. These properties are set when the [`HydeServiceProvider`](https://github.com/hydephp/framework/blob/master/src/Framework/HydeServiceProvider.php) -is registered, at which point the provider will search for any overrides in the config file. +is registered. At this point, the provider will search for any overrides in the config file. **This means that there are two options to change the source and output directories:** 1. **Recommended:** You can change the values in the config file, to let the `HydeServiceProvider` handle it for you. @@ -110,8 +110,8 @@ public function register(): void ### Route key impact For example, changing the output directory of Markdown posts to `blog` instead of `posts` will change the route key base from `posts` to `blog`. -This means that a file stored as `_posts/hello-world.md` will have the route key `blog/hello-world` instead of `posts/hello-world`, -this may break your site's configuration and links, so you should always verify your site works properly after such a change. +This means that a file stored as `_posts/hello-world.md` will have the route key `blog/hello-world` instead of `posts/hello-world`. +Note that this may break your site's configuration and links, so you should always verify your site works properly after such a change. You can learn more about this in the [route key documentation](core-concepts#paths-identifiers-and-route-keys). ## Custom Source Root diff --git a/docs/digging-deeper/advanced-markdown.md b/docs/digging-deeper/advanced-markdown.md index 8010b4305f6..d74b2842093 100644 --- a/docs/digging-deeper/advanced-markdown.md +++ b/docs/digging-deeper/advanced-markdown.md @@ -95,9 +95,9 @@ These are also created by using a custom Hyde feature that turns code comments i Simply add a code comment with the path in the **first line** of a fenced code block like so: ````markdown -// Filepath: _docs/advanced-markdown.md +// filepath: _docs/advanced-markdown.md ```php -‎// Filepath: hello-world.php +‎// filepath: hello-world.php echo 'Hello World!'; ``` @@ -106,7 +106,7 @@ echo 'Hello World!'; Which becomes: ```php -// Filepath: hello-world.php +// filepath: hello-world.php echo 'Hello World!'; ``` @@ -131,9 +131,9 @@ If you have enabled HTML in Markdown by setting the `allow_html` option to true anything within the path label will be rendered as HTML. This means you can add links, or even images to the label. ````markdown -// Filepath: View file on Github +// filepath: View file on Github ```markdown -‎// Filepath: View file on Github +‎// filepath: View file on Github ``` ```` diff --git a/docs/digging-deeper/customization.md b/docs/digging-deeper/customization.md index 6bdaafe30ac..665d1f8c499 100644 --- a/docs/digging-deeper/customization.md +++ b/docs/digging-deeper/customization.md @@ -438,7 +438,7 @@ arbitrary PHP code specified in Markdown to be executed. It's easy to enable how 'enable_blade' => true, ``` -See the [Blade in Markdown](advanced-markdown#blade-support) documentation for more information on how to use this feature. +See the [Blade in Markdown](advanced-markdown#using-blade-in-markdown) documentation for more information on how to use this feature. ## YAML Configuration diff --git a/docs/digging-deeper/helpers.md b/docs/digging-deeper/helpers.md index 7e4a0e68010..5ebdfde700a 100644 --- a/docs/digging-deeper/helpers.md +++ b/docs/digging-deeper/helpers.md @@ -98,11 +98,11 @@ If a `footer.md` file exists in the includes directory, Hyde will use that as th #### Head -If a `head.html` file exists in the includes directory, Hyde include that within the `` tag of the generated HTML, in addition to the one set in the `hyde.head` config option. +If a `head.html` file exists in the includes directory, Hyde will include that within the `` tag of the generated HTML, in addition to the one set in the `hyde.head` config option. #### Scripts -If a `scripts.html` file exists in the includes directory, Hyde include that at the end of the `` tag of the generated HTML, in addition to the one set in the `hyde.scripts` config option. +If a `scripts.html` file exists in the includes directory, Hyde will include that at the end of the `` tag of the generated HTML, in addition to the one set in the `hyde.scripts` config option. ## Reading-Time Helper @@ -208,7 +208,7 @@ From this, you can access the same methods as you would from the `Hyde` facade. ```php hyde(); // Returns the HydeKernel instance -hyde()->routes()) === Hyde::routes(); // true +hyde()->routes() === Hyde::routes(); // true ``` It's up to you if you want to use the facade or the global function, or a mix of both. @@ -444,8 +444,6 @@ just apply these changes to that new view, but for this example I'm going to upd

{{ $page->matter('title') ?? $title }}

{{-- [tl! add] --}} ``` -to that new view, but for this example I'm going to update the `posts` view. - ```blade // filepath _pages/posts.blade.php @php diff --git a/docs/extensions/ui-kit.md b/docs/extensions/ui-kit.md index 841dfbc8096..544951b0b51 100644 --- a/docs/extensions/ui-kit.md +++ b/docs/extensions/ui-kit.md @@ -1,7 +1,7 @@ # 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 +intended 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 Tailwind and Vite configuration. ## Screenshot diff --git a/docs/getting-started/core-concepts.md b/docs/getting-started/core-concepts.md index 678c2685f7c..1667466a6f8 100644 --- a/docs/getting-started/core-concepts.md +++ b/docs/getting-started/core-concepts.md @@ -103,7 +103,7 @@ As you can see, the route key is simply put the relative page URL, without the . ## Convention Over Configuration Hyde favours the "Convention over Configuration" paradigm and thus comes preconfigured with sensible defaults. -However, Hyde also strives to be modular and endlessly customizable hackable if you need it. +However, Hyde also strives to be modular and endlessly customizable and hackable if you need it. Take a look at the [customization and configuration guide](customization) to see the endless options available! ## Front Matter @@ -174,7 +174,7 @@ any custom Blade templates, you can safely ignore this section. If you are, here - `$route`: The [Route Object](#automatic-routing) for the current page. - `$routeKey`: The [Route Key](#paths-identifiers-and-route-keys) for the current page. -The `$page` variable is likely to the most important one, as it contains all the data for the current page. +The `$page` variable is likely to be the most important one, as it contains all the data for the current page. Depending on the page type, you will have different helpers available. But `$page->matter()` is likely to be very helpful. You can see all the helpers in the [Page API](hyde-pages) reference page. diff --git a/docs/getting-started/front-matter.md b/docs/getting-started/front-matter.md index bff39ed2ea1..a599c447423 100644 --- a/docs/getting-started/front-matter.md +++ b/docs/getting-started/front-matter.md @@ -41,7 +41,7 @@ The specific usage and schemas used for pages are documented in their respective - The front matter should be the very first thing in the Markdown file. - Each key-pair value should be on its own line. -**To use Front Matter, add Yaml to the top of your Markdown file:** +**To use Front Matter, add YAML to the top of your Markdown file:** ```markdown --- diff --git a/monorepo/gh-pages/gh-pages-config/_pages/markdown-page.md b/monorepo/gh-pages/gh-pages-config/_pages/markdown-page.md index 3a70ccc2704..b99b6df180b 100644 --- a/monorepo/gh-pages/gh-pages-config/_pages/markdown-page.md +++ b/monorepo/gh-pages/gh-pages-config/_pages/markdown-page.md @@ -18,7 +18,7 @@ Here are some custom Markdown features Hyde provides! ### Automatic file path labels for code blocks ```php -// Filepath: Hello.php +// filepath: Hello.php echo 'A file path label has been added to the top right corner.'; ``` diff --git a/packages/framework/config/docs.php b/packages/framework/config/docs.php index 4ac1dd70706..9650b1f057c 100644 --- a/packages/framework/config/docs.php +++ b/packages/framework/config/docs.php @@ -90,7 +90,7 @@ | | Example: https://github.com/hydephp/docs/blob/master | Do not specify the filename or extension, Hyde will do that for you. - | Setting the setting to null will disable the feature. + | Setting this to null will disable the feature. | */ diff --git a/packages/framework/config/hyde.php b/packages/framework/config/hyde.php index 408ababf05e..ba8757a0dc5 100644 --- a/packages/framework/config/hyde.php +++ b/packages/framework/config/hyde.php @@ -138,7 +138,7 @@ | Site Output Directory |-------------------------------------------------------------------------- | - | This setting specifies the output path for your site, useful to for + | This setting specifies the output path for your site, useful to, for | example, store the site in the docs/ directory for GitHub Pages. | The path is relative to the root of your project. | @@ -308,7 +308,7 @@ | | Here you can customize the footer Markdown text for your site. | - | If you don't want to write Markdown here, you use a Markdown include. + | If you don't want to write Markdown here, you can use a Markdown include. | You can also customize the Blade view if you want a more complex footer. | You can disable it completely by changing the setting to `false`. | @@ -428,7 +428,7 @@ | | Here you can configure settings for the built-in realtime compiler server. | The server also includes a magic dashboard feature that supercharges - | your local development! This feature can alo be customised here. + | your local development! This feature can also be customised here. | */ diff --git a/packages/framework/config/markdown.php b/packages/framework/config/markdown.php index cd9afdea0e5..b872c1a739e 100644 --- a/packages/framework/config/markdown.php +++ b/packages/framework/config/markdown.php @@ -71,7 +71,7 @@ | | This feature allows you to use basic Laravel Blade in Markdown files. | - | It's disabled by default since can be a security risk as it allows + | It's disabled by default since it can be a security risk as it allows | arbitrary PHP to run. But if your Markdown is trusted, try it out! | | To see the syntax and usage, see the documentation: diff --git a/tests/fixtures/markdown-features.md b/tests/fixtures/markdown-features.md index 1d33e4eaaef..9ac7030d5cb 100644 --- a/tests/fixtures/markdown-features.md +++ b/tests/fixtures/markdown-features.md @@ -16,7 +16,7 @@ Here are some custom Markdown features Hyde provides! ### Automatic file path labels for code blocks ```php -// Filepath: Hello.php +// filepath: Hello.php echo 'A file path label has been added to the top right corner.'; ```