From 396a9e18fbd9e035eb583277fd56119cf853942a Mon Sep 17 00:00:00 2001 From: Caen De Silva Date: Thu, 8 Feb 2024 14:38:38 +0100 Subject: [PATCH 1/2] Spelling and formatting --- docs/advanced-features/build-tasks.md | 5 +++-- docs/advanced-features/hyde-pages.md | 8 ++++---- docs/advanced-features/in-memory-pages.md | 10 +++++----- docs/architecture-concepts/autodiscovery.md | 2 +- .../architecture-concepts/automatic-routing.md | 2 +- .../dynamic-data-discovery.md | 4 ++-- docs/architecture-concepts/extensions-api.md | 10 +++++----- docs/architecture-concepts/the-hydekernel.md | 10 +++++----- docs/creating-content/blog-posts.md | 10 +++++----- docs/creating-content/compile-and-deploy.md | 2 +- docs/creating-content/documentation-pages.md | 10 +++++----- docs/creating-content/managing-assets.md | 18 +++++++++--------- docs/creating-content/static-pages.md | 13 +++++++------ docs/digging-deeper/advanced-customization.md | 10 +++++----- 14 files changed, 58 insertions(+), 56 deletions(-) diff --git a/docs/advanced-features/build-tasks.md b/docs/advanced-features/build-tasks.md index 6cf038a4ee3..dc9a23cdf68 100644 --- a/docs/advanced-features/build-tasks.md +++ b/docs/advanced-features/build-tasks.md @@ -111,7 +111,7 @@ They are shown here in order of presumed convenience, but you are free to choose ### Autodiscovery registration -The easiest way to register build tasks, is to not do it. Just let Hyde do it for you! +The easiest way to register build tasks is to not do it -- just let Hyde do it for you! Any classes that end in `BuildTask.php` that are stored in `app/Actions` will be autoloaded and registered to run automatically. @@ -139,7 +139,8 @@ or you can register the extensions programmatically, I recommend you do this in The build tasks are registered in an internal array of the `BuildService` class, which is bound as a singleton in the underlying Laravel service container. To actually register your task, provide the fully qualified class name of the task to the `BuildTaskService::registerTask()` method. -Here is an example of how to do this using in a service provider. Though you could technically do it anywhere using the `app()` helper, just as long as it's done early enough in the application lifecycle, so it's registered before the build command is executed. +Here is an example of how to do this using a service provider. Though you could technically do it anywhere using the `app()` helper, +just as long as it's done early enough in the application lifecycle, so it's registered before the build command is executed. ```php class MyServiceProvider extends ServiceProvider diff --git a/docs/advanced-features/hyde-pages.md b/docs/advanced-features/hyde-pages.md index 4a65b7c1935..eff92d33cc6 100644 --- a/docs/advanced-features/hyde-pages.md +++ b/docs/advanced-features/hyde-pages.md @@ -41,12 +41,12 @@ under the `HydePage` class documentation which is conveniently located just belo ## HydePage -The base class for all Hyde pages, all other page classes extend this class. +The base class for all Hyde pages. All other page classes extend this class. -Unlike other frameworks, in general you don't instantiate pages yourself in Hyde, instead, the page models acts as +Unlike other frameworks, you generally don't instantiate pages yourself in Hyde. Instead, the page models act as blueprints defining information for Hyde to know how to parse a file, and what data around it should be generated. -To create a parsed file instance, you'd typically just create a source file, and you can then access the parsed file +To get a parsed file instance, you'd typically just create a source file, and you can then access the parsed file from the HydeKernel's page index. In Blade views, you can always access the current page instance being rendered using the `$page` variable. @@ -320,7 +320,7 @@ class DocumentationPage extends BaseMarkdownPage Page class for HTML pages. -Html pages are stored in the `_pages` directory and using the `.html` extension. +HTML pages are stored in the `_pages` directory and using the `.html` extension. These pages will be copied exactly as they are to the `_site/` directory. ### Quick Reference diff --git a/docs/advanced-features/in-memory-pages.md b/docs/advanced-features/in-memory-pages.md index cf29f89dced..e9377b91f22 100644 --- a/docs/advanced-features/in-memory-pages.md +++ b/docs/advanced-features/in-memory-pages.md @@ -13,22 +13,22 @@ autodiscovery, you may benefit from creating a custom page class instead, as tha ### About discovery -Since the InMemoryPages are not present in the filesystem, they cannot be found by the auto-discovery process, -thus it's up to the developer to manually register them. If you are developing for your own project, you can do this in +Since the InMemoryPages are not present in the filesystem, they cannot be found by the auto-discovery process. +Instead, it's up to the developer to manually register them. If you are working on your own project, you can do this in the `boot` method of a service provider, such as the `AppServiceProvider` which is already present in your `app/` directory. If you are developing a package, you may instead want to register the page in your package extension class, within the page collection callback. In either case, if you want your page to be able to be fully processed by Hyde, you need to make sure you register it before the full application is booted so that routes can be generated. -_To see how to register the page, see the examples below, first we must look at how to actually create the page._ +_To see how to register the page, see the examples below. But first we must look at how to actually create the page._ ## Creating the page -To create an InMemoryPage, you need to instantiate it, and pass it the required parameters. +To create an InMemoryPage, you need to instantiate it with the required parameters. -A page would not be useful without any content to render. The class offers two content options through the constructor. +Since a page would not be useful without any content to render, the class offers two content options through the constructor. You can either pass a string to the `$contents` parameter, Hyde will then save that literally as the page's contents. diff --git a/docs/architecture-concepts/autodiscovery.md b/docs/architecture-concepts/autodiscovery.md index ab996322606..8981975088b 100644 --- a/docs/architecture-concepts/autodiscovery.md +++ b/docs/architecture-concepts/autodiscovery.md @@ -55,7 +55,7 @@ The kernel is also where the discovered data is stored in memory, so it's import ### The kernel lifecycle Now that we know the role of the HydeKernel, let's take a look at its lifecycle. The kernel is "lazy-booted", meaning -that the all the heavy lifting only happens when you actually need it. Once booted, the kernel data will stay in memory +that all the heavy lifting only happens when you actually need it. Once booted, the kernel data will stay in memory until the console application is terminated. The kernel data is primarily stored in three collections that get generated during the kernel's boot process. diff --git a/docs/architecture-concepts/automatic-routing.md b/docs/architecture-concepts/automatic-routing.md index cb482a70e5b..b4b2ac221d8 100644 --- a/docs/architecture-concepts/automatic-routing.md +++ b/docs/architecture-concepts/automatic-routing.md @@ -45,7 +45,7 @@ Routes::get('docs/readme') When designing Blade layouts it can be useful to use the `x-link` component to automatically resolve relative links. -You can of course, use it just like a normal anchor tag like so: +You can of course use it just like a normal anchor tag like so: ```blade Home diff --git a/docs/architecture-concepts/dynamic-data-discovery.md b/docs/architecture-concepts/dynamic-data-discovery.md index 1275d758be4..65c06ae7cd0 100644 --- a/docs/architecture-concepts/dynamic-data-discovery.md +++ b/docs/architecture-concepts/dynamic-data-discovery.md @@ -31,7 +31,7 @@ You might also want to read about the [autodiscovery lifecycle](autodiscovery) f After basic information about the page has been gathered, such as the source file information and the front matter, the page model is run through a series of factories. These are just classes that work around the limited data -that is available at this point, and will assign the rich data needed to make your Hyde page awesome. +that is available at this point and will generate the rich data used to make your Hyde page awesome. There are a few factory classes. The one we will be looking at here is the `HydePageDataFactory` class, which is responsible for data applicable to all page models. Complex structures and data only relevant to some page types @@ -94,4 +94,4 @@ foreach ($data->toArray() as $key => $value) { } ``` -And that's pretty much it! Hyde will do this for all the data it can discover, all so that you can focus on your content. +And that's pretty much it! Hyde will do this for all the data it can discover, freeing you to focus on your content. diff --git a/docs/architecture-concepts/extensions-api.md b/docs/architecture-concepts/extensions-api.md index 9ed5a4bcab3..f6abd2b4109 100644 --- a/docs/architecture-concepts/extensions-api.md +++ b/docs/architecture-concepts/extensions-api.md @@ -6,7 +6,7 @@ navigation.priority: 1000 ## Introduction -The Extensions API a powerful interface designed for package developers who want to extend the functionality of HydePHP. +The Extensions API is a powerful interface designed for package developers who want to extend the functionality of HydePHP. Using the API, you can hook directly into the HydePHP Kernel and extend sites with custom page types and new features. @@ -24,7 +24,7 @@ so you can understand how your code works with the internals. ### The why and how of the Extensions API -HydePHP being a static site generator, the Extensions API is centered around [Page Models](page-models), +HydePHP being a static site generator, the Extensions API is centred around [Page Models](page-models), which you are hopefully already familiar with, otherwise you should read up on them first. What the Extensions API does is to allow you to create custom page types, and tell HydePHP how to discover them. @@ -73,11 +73,11 @@ If our pages need more complex discovery logic, we can create custom handlers. s ### Discovery handlers -The discovery handlers lets you run code at various points of the booting process. This is usually only needed if your +The discovery handlers let you run code at various points of the booting process. This is usually only needed if your page models cannot provide the information required for Hyde run the standard auto-discovery, and thus need custom logic. Usually in these cases, you would only need to add files to the Kernel `FileCollection`, -though the `HydeExtension` class offers following three discovery handlers, in case you need them: +though the `HydeExtension` class offers the following three discovery handlers, in case you need them: ```php /** Runs during file discovery */ @@ -111,7 +111,7 @@ class JsonPageExtension extends HydeExtension { ``` Since the discovery steps are handled sequentially, the added pages will automatically be discovered as routes without -us having to implement that handler method. As we inject the page objects directly, we bypass the need of the `FileCollection`. +us having to implement that handler method. As we inject the page objects directly, we bypass the need for the `FileCollection`. ## Registering your extension diff --git a/docs/architecture-concepts/the-hydekernel.md b/docs/architecture-concepts/the-hydekernel.md index 92256389325..0bb6b2d4c63 100644 --- a/docs/architecture-concepts/the-hydekernel.md +++ b/docs/architecture-concepts/the-hydekernel.md @@ -21,13 +21,12 @@ as a singleton into the application service container. ## Accessing the kernel -The HydeKernel It is stored as a singleton in this class, and is bound into the -Laravel Application Service Container, and can be accessed in a few ways. +The HydeKernel is stored as a singleton in a static property in its own class and can be accessed in a few ways. -Commonly, you'll use the `Hyde` facade, but you can also use Dependency Injection -by type-hinting the `HydeKernel::class`, or use the `hyde()` function to get the Kernel. +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. -The Kernel instance is constructed in `bootstrap.php`, and is available globally as `$hyde`. +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. @@ -42,6 +41,7 @@ app(HydeKernel::class)->version(); hyde()->version(); ``` +The Kernel instance is constructed in `bootstrap.php`, and is available globally as `$hyde`. ## The kernel lifecycle diff --git a/docs/creating-content/blog-posts.md b/docs/creating-content/blog-posts.md index 2c24e06becc..41f7f087ced 100644 --- a/docs/creating-content/blog-posts.md +++ b/docs/creating-content/blog-posts.md @@ -10,7 +10,7 @@ navigation: Making blog posts with Hyde is easy. At the most basic level, all you need is to add a Markdown file to your `_posts` folder. -To use the full power of the Hyde post module however, you'll want to add YAML [Front Matter](front-matter) to your posts. +To use the full power of the Hyde post module you'll want to add YAML [Front Matter](front-matter) to your posts. **You can interactively scaffold posts with automatic front matter using the HydeCLI:** @@ -54,7 +54,7 @@ and understand how your front matter is used. You can read more about the Front ### Blog Post Example -Before digging in deeper on all the supported options, let's take a look at what a basic post with front matter looks like. +Before digging deeper into all the supported options, let's take a look at what a basic post with front matter looks like. ```markdown // filepath _posts/my-new-post.md @@ -90,8 +90,8 @@ Keep on reading to see further explanations, details, and examples. | `author` | string/array | _See [author](#author) section_ | | `image` | string/array | _See [image](#image) section_ | -Note that YAML here is pretty forgiving. In most cases you do not need to wrap strings in quotes, -but it can help in certain edge cases, for example if the text contains special Yaml characters, thus they are included here. +Note that YAML here is pretty forgiving. In most cases you do not need to wrap strings in quotes. +However, it can help in certain edge cases, for example if the text contains special Yaml characters, thus they are included here. In the examples below, when there are multiple examples, they signify various ways to use the same property. @@ -212,4 +212,4 @@ To use images stored in the `_media/` directory, you can use the following synta _Note the relative path since the blog post is compiled to `posts/example.html`_ -To learn more, check out the [chapter in managing assets](managing-assets#managing-images) +To learn more, check out the [managing assets chapter](managing-assets#managing-images) on the topic. diff --git a/docs/creating-content/compile-and-deploy.md b/docs/creating-content/compile-and-deploy.md index 5f457ffd3b4..bfdb31f909d 100644 --- a/docs/creating-content/compile-and-deploy.md +++ b/docs/creating-content/compile-and-deploy.md @@ -56,7 +56,7 @@ Once the site is compiled there is nothing to configure or worry about. ### FTP and File Managers If you have a conventional web host, you can use `FTP`/`SFTP`/`FTPS` to upload your compiled site files to the web server. -Some web hosting services also have web based file managers. +Some web hosting services also have web-based file managers. To deploy your site using any of these methods, all you need to do is upload the entire contents of your `_site` directory to the web server's public document root, which is usually the `public_html`, `htdocs`, or `www` directory. diff --git a/docs/creating-content/documentation-pages.md b/docs/creating-content/documentation-pages.md index 9555fcd2c53..29d61dffa1e 100644 --- a/docs/creating-content/documentation-pages.md +++ b/docs/creating-content/documentation-pages.md @@ -28,7 +28,7 @@ to keep in mind when creating blog posts so that you don't get unexpected result #### Filenames -- Hyde Documentation pages are files are stored in the `_docs` directory +- Hyde Documentation pages are files stored in the `_docs` directory - The filename is used as the filename for the compiled HTML - Filenames should use `kebab-case-name` format, followed by the appropriate extension - Files prefixed with `_underscores` are ignored by Hyde @@ -267,7 +267,7 @@ You can also disable the feature completely. ### Using flattened output paths If this setting is set to true, Hyde will output all documentation pages into the same configured documentation output directory. -This means that you can use the automatic directory based grouping feature, but still have a "flat" output structure. +This means that you can use the automatic directory-based grouping feature, but still have a "flat" output structure. Note that this means that you can't have two documentation pages with the same filename or navigation menu label as they will overwrite each other. If you set this to false, Hyde will match the directory structure of the source files (just like all other pages). @@ -285,7 +285,7 @@ If you set this to false, Hyde will match the directory structure of the source The HydeSearch plugin adds a search feature to documentation pages. It consists of two parts, a search index generator that runs during the build command, and a frontend JavaScript plugin that adds the actual search widget. ->info Tip: The HydeSearch plugin is what powers the search feature on this site! Why not [try it out](search)! +>info Tip: The HydeSearch plugin is what powers the search feature on this site! Why not [try it out](search)? The search feature is enabled by default. You can disable it by removing the `documentationSearch` from the Hyde `Features` config array. @@ -329,7 +329,7 @@ The Realtime Compiler that powers the `php hyde serve` command will automaticall ### Introduction -Hyde can automatically add links to documentation pages that takes the user +Hyde can automatically add links to documentation pages that take the user to a GitHub page (or similar) to edit the page. This makes it great for open-source projects looking to allow others to contribute to the documentation in a quick and easy manner. @@ -341,7 +341,7 @@ if not, please send a PR and/or create an issue on the [GitHub repository](https ### Configuration -As an example configuration, let's take a practical example for how HydePHP.com uses this feature. +As an example configuration, let's take a practical example of how HydePHP.com uses this feature. ```php // Filepath: config/docs.php diff --git a/docs/creating-content/managing-assets.md b/docs/creating-content/managing-assets.md index a7f3ccf9e06..79f86f45699 100644 --- a/docs/creating-content/managing-assets.md +++ b/docs/creating-content/managing-assets.md @@ -9,14 +9,14 @@ navigation: Managing and compiling assets is a very common task in web development. Unfortunately, it's rarely fun. -With hyde, **you don't have to do it**, in fact, you can skip this entire page if you are happy with how it is. +With Hyde, **you don't have to do it**, in fact, you can skip this entire page if you are happy with how it is. But as always with Hyde, you can customize everything if you want to. Hyde ships with a complete frontend using Blade views, TailwindCSS styles, and Alpine.js interactions. Some extra custom styles are made in the HydeFront package, which is pre-installed and bundled in the pre-configured Laravel Mix. -To get you started quickly, all the styles are already compiled minified into `_media/app.css`, which will be copied -to the `_site/media/app.css` directory when you run `php hyde build`. +To get you started quickly, all the styles are already compiled and minified into `_media/app.css`, +which will be copied to the `_site/media/app.css` directory when you run `php hyde build`. ## Additional Information and Answers to Common Questions @@ -38,7 +38,7 @@ If you use Markdown-based pages, you do not need to compile anything as those st The frontend assets are separated into three places. -- The `resources/assets` contains **source** files, meaning files that will be compiled into something else. +- The `resources/assets` folder contain **source** files, meaning files that will be compiled into something else. Here you will find the `app.css` file that bootstraps the TailwindCSS styles. This file is also an excellent place to add your custom styles. It is also where we import HydeFront. If you compile this file in the base install, it will output the same file that's already included in Hyde. @@ -64,12 +64,12 @@ You can also run `npm run watch` to watch for changes in the source files and re ### How does it work? -Hyde uses [Laravel Mix](https://laravel-mix.com/) (which is a wrapper for [webpack](https://webpack.js.org/)) to compile the assets. +Hyde uses [Laravel Mix](https://laravel-mix.com/) (which is a wrapper for [Webpack](https://webpack.js.org/)) to compile the assets. When running the `npm run dev/prod` command, the following happens: 1. Laravel Mix will compile the `resources/assets/app.css` file into `_media/app.css` using PostCSS with TailwindCSS and AutoPrefixer. -2. Mix then copies the `_media` folder into `_site/media`, this is so that they are automatically accessible to your site without having to rerun `php hyde build`, making blend perfectly with the realtime compiler (`php hyde serve`). +2. Mix then copies the `_media` folder into `_site/media`, this is so that they are automatically accessible to your site without having to rerun `php hyde build`. ## Telling Hyde where to find assets @@ -118,7 +118,7 @@ making it the recommended place to store images. You can then easily reference t ### Referencing images -The recommended way to reference images are with relative paths as this offers the most compatibility, +The recommended way to reference images is with relative paths as this offers the most compatibility, allowing you to browse the site both locally on your filesystem and on the web when serving from a subdirectory. >warning Note: The path is relative to the compiled file in the site output @@ -132,7 +132,7 @@ The path to use depends on the location of the page. Note the subtle difference #### Making images accessible -To improve accessibility, you should always add an `alt` text. Here is a full example for an image in a blog post: +To improve accessibility, you should always add an `alt` text. Here is a full example including an image in a blog post: ```markdown ![Image Alt](../media/image.png "Image Title") # Note the relative path @@ -142,4 +142,4 @@ To improve accessibility, you should always add an `alt` text. Here is a full ex Hyde offers great support for creating data-rich and accessible featured images for blog posts. -You can read more about this in the [creating blog posts page](blog-posts#image). +You can read more about this on the [creating blog posts page](blog-posts#image). diff --git a/docs/creating-content/static-pages.md b/docs/creating-content/static-pages.md index 25dcc8e8447..c5171d3d11d 100644 --- a/docs/creating-content/static-pages.md +++ b/docs/creating-content/static-pages.md @@ -9,9 +9,9 @@ navigation: ## Introduction to Hyde Pages Hyde offers two ways to create static pages: -**Markdown pages** which are perfect for simple pages that focuses heavily on the content, +**Markdown pages** which are perfect for simple pages that focus heavily on the content, and **Blade pages** which are perfect for more complex pages where you want full control over the HTML, -and where you may want to include other components. +and where you may want to include other components or want to use dynamic PHP code. Let's start with the basics. @@ -22,7 +22,7 @@ to keep in mind when creating blog posts so that you don't get unexpected result #### Filenames -- Hyde Pages are files are stored in the `_pages` directory +- Hyde Pages are files stored in the `_pages` directory - The filename is used as the filename for the compiled HTML - Filenames should use `kebab-case-identifier` format, followed by the appropriate extension - Files prefixed with `_underscores` are ignored by Hyde @@ -128,7 +128,8 @@ if you don't want to use the scaffolding command. Markdown pages look great and work well for simple "about" pages and the like, but with Markdown we are still pretty limited. -If you are comfortable with it, and have the need for it, use Blade to create more complex pages! And mix and match between them! Some page types are better suited for Markdown, and others for Blade. +If you are comfortable with it and have the need for it, use Blade to create more complex pages! And mix and match between them! +Some page types are better suited for Markdown, and others for Blade. Don't limit yourself to just one type. ### Comparison @@ -136,10 +137,10 @@ If you are comfortable with it, and have the need for it, use Blade to create mo |-----------------------------------------------------|-------------------------------------------------------------------------------------| | ➕ Easily created and updated | ➕ Full control over the HTML | | ➕ Very fast to create simple and lightweight pages | ➕ Use the default app layout or create your own | -| ➕ Suited for content heavy pages such as "about us" | ➕ Use Blade templates and components to keep code DRY | +| ➕ Suited for content-heavy pages such as "about us" | ➕ Use Blade templates and components to keep code DRY | | ➖ Not as flexible as Blade pages | ➕ Use arbitrary PHP right in the page to create dynamic content | | | ➕ Access to all Blade helper directives like @foreach, @if, etc. | -| | ➖ Takes longer to create as as you need to write the markup | +| | ➖ Takes longer to create as you need to write the markup | | | ➖ You may need to [recompile your CSS](managing-assets) if you add Tailwind classes | ### Live Demos diff --git a/docs/digging-deeper/advanced-customization.md b/docs/digging-deeper/advanced-customization.md index 2e693910329..5270878d0f3 100644 --- a/docs/digging-deeper/advanced-customization.md +++ b/docs/digging-deeper/advanced-customization.md @@ -11,7 +11,7 @@ navigation: This page covers advanced usage and is intended for developers who know what they are doing. Documentation here will be mainly example driven, as it is assumed you have somewhat of an understanding of what you are doing already. -### Prerequisites for Customizing directories +### Prerequisites for customizing directories >info Before customizing source and output directories it may be helpful to know how these settings are stored internally. @@ -32,8 +32,8 @@ is registered, at which point the provider will search for any overrides in the ## Customizing source directories The directories you place your content in are important. The directory will be used to determine the proper page type and the templates used. -If you are not happy with defaults, you can change them. Note that these are relative to the `source_root` setting, -which is the root of your project by default. +If you are not happy the with defaults, you can change them. Note that these are relative to the `source_root` setting, +which is the root of your project, by default. Note that you need to take care of conflicts when changing the source directories. For example, if you store Markdown posts in the same directory as documentation pages, Hyde will not know which page type to use. @@ -113,7 +113,7 @@ public function register(): void 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, so you should always verify the impact to your site of such a change. +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). @@ -159,7 +159,7 @@ You can change the path to this directory by setting the `media_directory` optio 1. Note that you will likely need to manually update `webpack.mix.js` so Laravel Mix can compile the assets correctly. 2. You will of course also need to copy over any existing files from the old directory to the new one. -#### Setting changes both source and output directories +#### Note that this setting affects both source and output directories Note that this change will affect both the source and output directories. For example, if you set the value to `assets`, all files from `assets` will be copied to `_site/assets`. If the setting starts with an underscore, that will be removed From 9a7689b1d778e53070c0339c144151e7041e35c0 Mon Sep 17 00:00:00 2001 From: Caen De Silva Date: Thu, 8 Feb 2024 14:40:48 +0100 Subject: [PATCH 2/2] British English spelling --- docs/creating-content/documentation-pages.md | 6 +++--- docs/creating-content/managing-assets.md | 2 +- docs/extensions/ui-kit.md | 2 +- packages/ui-kit/docs/documentation.md | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/creating-content/documentation-pages.md b/docs/creating-content/documentation-pages.md index 29d61dffa1e..f3ab7ce538a 100644 --- a/docs/creating-content/documentation-pages.md +++ b/docs/creating-content/documentation-pages.md @@ -123,7 +123,7 @@ _I personally think the config route is easier as it gives an instant overview, ### Sidebar labels -The sidebar items are labeled with the `label` property. The default label is the filename of the file. +The sidebar items are labelled with the `label` property. The default label is the filename of the file. You can change it with the following front matter: ```yaml @@ -252,7 +252,7 @@ Please note that this option is not added to the config file by default, as it's ### Table of contents settings -In the `config/docs.php` file you can configure the behavior, content, and the look and feel of the sidebar table of contents. +In the `config/docs.php` file you can configure the behaviour, content, and the look and feel of the sidebar table of contents. You can also disable the feature completely. ```php @@ -303,7 +303,7 @@ The search works by generating a JSON search index which the JavaScript plugin l Two ways to access the search are added, one is a full page search screen that will be saved to `docs/search.html`. The second method is a button added to the documentation pages, similar to how Algolia DocSearch works. -Opening it will open a modal with an integrated search screen. You can also open the dialog using the keyboard shortcut `/`. +Opening it will open a modal with an integrated search screen. You can also open the dialogue using the keyboard shortcut `/`. >info The full page can be disabled by setting `create_search_page` to `false` in the `docs` config. diff --git a/docs/creating-content/managing-assets.md b/docs/creating-content/managing-assets.md index 79f86f45699..86a66e1a38f 100644 --- a/docs/creating-content/managing-assets.md +++ b/docs/creating-content/managing-assets.md @@ -53,7 +53,7 @@ all asset files here will get copied as they are into the `_site/media` folder. It may seem weird to have two folders for storing the compiled assets, but it is quite useful. The `_site` directory is intended to be excluded from version control, while the `_media` folder is included in the -version control. You are of course free to modify this behavior by editing the `webpack.mix.js` file to change the output directory. +version control. You are of course free to modify this behaviour by editing the `webpack.mix.js` file to change the output directory. ## How do I compile assets? diff --git a/docs/extensions/ui-kit.md b/docs/extensions/ui-kit.md index ea4431b33b5..b632c0719cc 100644 --- a/docs/extensions/ui-kit.md +++ b/docs/extensions/ui-kit.md @@ -93,7 +93,7 @@ Why not combine the components? #### Heading -This component will create a styled `

` level heading centered on the page. +This component will create a styled `

` level heading centred on the page. ```blade diff --git a/packages/ui-kit/docs/documentation.md b/packages/ui-kit/docs/documentation.md index 079305a6411..946c82e3a73 100644 --- a/packages/ui-kit/docs/documentation.md +++ b/packages/ui-kit/docs/documentation.md @@ -97,7 +97,7 @@ Why not combine the components? #### Heading -This component will create a styled `

` level heading centered on the page. +This component will create a styled `

` level heading centred on the page. ```blade