Skip to content

Commit

Permalink
Upload documentation preview for PR #685
Browse files Browse the repository at this point in the history
  • Loading branch information
caendesilva committed Feb 12, 2023
1 parent 7eebac4 commit 568e100
Show file tree
Hide file tree
Showing 25 changed files with 40 additions and 40 deletions.
12 changes: 6 additions & 6 deletions pr-685/dev-docs-preview/advanced-customization.html
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ <h1>Advanced Customization</h1>
</header>
<section id="document-main-content" itemprop="articleBody">
<h2>Introduction &amp; Warning<a id="introduction--warning" href="#introduction--warning" class="heading-permalink" aria-hidden="true" title="Permalink">#</a></h2>
<blockquote class="danger">Danger lies ahead! Read this before you proceed.</blockquote>
<blockquote class="danger"><p>Danger lies ahead! Read this before you proceed.</p></blockquote>
<p>This page covers advanced usage of potentially experimental and unstable features and is intended for developers
who know what they are doing and can handle the risk of breaking things. The article will also cover things
that you <em>can</em> do, but that you maybe should not. With great power comes great responsibility. You have been warned.</p>
Expand All @@ -245,7 +245,7 @@ <h3>Emoji legend<a id="emoji-legend" href="#emoji-legend" class="heading-permali
<h3>A note on file paths<a id="a-note-on-file-paths" href="#a-note-on-file-paths" class="heading-permalink" aria-hidden="true" title="Permalink">#</a></h3>
<p>When Hyde references files, especially when passing filenames between components, the file path is almost always relative to the root of the project. When an absolute path is required, the path is resolved through the <code>Hyde::path()</code> helper. Specifying absolute paths yourself will likely lead to unforeseen problems.</p>
<h2>Customizing source directories 🧪<a id="customizing-source-directories-" href="#customizing-source-directories-" class="heading-permalink" aria-hidden="true" title="Permalink">#</a></h2>
<blockquote class="warning">This may cause integrations such as the realtime compiler to break. You'll also likely need to update route key names in your templates.</blockquote>
<blockquote class="warning"><p>This may cause integrations such as the realtime compiler to break. You'll also likely need to update route key names in your templates.</p></blockquote>
<p>The source directory paths are stored in the PageModel objects.
You can change them by modifying the static property, for example in a service provider.</p>
<p>Internally, the paths are registered in the HydeServiceProvider using the following method:</p>
Expand Down Expand Up @@ -275,10 +275,10 @@ <h2>Custom media directory 🧪<a id="custom-media-directory-" href="#custom-med
Note that this change will affect both the source and output directories. For example, if you set the value to <code>assets</code>,
all files from <code>assets</code> will be copied to <code>_site/assets</code>.</p>
<p>If the setting starts with an underscore, that will be removed from the output directory, so files in <code>_assets</code> will be copied to <code>_site/assets</code>.</p>
<blockquote class="info">Note that you will likely need to manually update `webpack.mix.js` so Laravel Mix can compile the assets correctly.</blockquote>
<blockquote class="info">You will of course also need to copy over any existing files from the old directory to the new one.</blockquote>
<blockquote class="info"><p>Note that you will likely need to manually update <code>webpack.mix.js</code> so Laravel Mix can compile the assets correctly.</p></blockquote>
<blockquote class="info"><p>You will of course also need to copy over any existing files from the old directory to the new one.</p></blockquote>
<h2>Customizing the output directory ⚠<a id="customizing-the-output-directory-" href="#customizing-the-output-directory-" class="heading-permalink" aria-hidden="true" title="Permalink">#</a></h2>
<blockquote class="danger">Hyde deletes all files in the output directory before compiling the site. Don't set this path to a directory that contains important files!</blockquote>
<blockquote class="danger"><p>Hyde deletes all files in the output directory before compiling the site. Don't set this path to a directory that contains important files!</p></blockquote>
<p>If you want to store your compiled website in a different directory than
the default <code>_pages</code>, you can change the path using the following configuration option in config/hyde.php. The path is expected to be relative to your project root.</p>
<pre><code class="language-php"><small class="filepath not-prose"><span class="sr-only">Filepath: </span>config/hyde.php</small>return [
Expand Down Expand Up @@ -442,7 +442,7 @@ <h3>Registering the tasks<a id="registering-the-tasks" href="#registering-the-ta
<div class="bg-white dark:bg-gray-800 rounded-lg shadow-lg p-4">
<header class="flex flex-row nowrap items-center justify-between">
<h3 class="text-lg font-bold mb-2 mr-3 flex">Documentation preview for&nbsp; <a href="https://github.com/hydephp/develop/pull/685" class="dark:text-indigo-400 text-indigo-500 hover:text-indigo-600">PR #685</a> &nbsp;
<small class="opacity-75">(#<a href="https://github.com/hydephp/develop/commit/947d7009e51a6e3acf64622f9246245b6c1bfcf1"><span style=" display: inline-flex; font-family: monospace; width: 7ch; white-space: nowrap; overflow: hidden; text-overflow: clip;">947d7009e51a6e3acf64622f9246245b6c1bfcf1</span></a>)</small>
<small class="opacity-75">(#<a href="https://github.com/hydephp/develop/commit/c30c22db2dad6d34db231ca06e75bdba0533da34"><span style=" display: inline-flex; font-family: monospace; width: 7ch; white-space: nowrap; overflow: hidden; text-overflow: clip;">c30c22db2dad6d34db231ca06e75bdba0533da34</span></a>)</small>
</h3>
<small class="mb-2">
<a href="https://github.com/hydephp/develop/pull/685" class="dark:text-indigo-400 text-indigo-500 hover:text-indigo-600">Back to PR</a>
Expand Down
10 changes: 5 additions & 5 deletions pr-685/dev-docs-preview/advanced-markdown.html
Original file line number Diff line number Diff line change
Expand Up @@ -280,10 +280,10 @@ <h2>Coloured Blockqoutes<a id="coloured-blockqoutes" href="#coloured-blockqoutes
<blockquote>
<p>Normal Blockquote</p>
</blockquote>
<blockquote class="info">Info Blockquote</blockquote>
<blockquote class="warning">Warning Blockquote</blockquote>
<blockquote class="danger">Danger Blockquote</blockquote>
<blockquote class="success">Success Blockquote</blockquote>
<blockquote class="info"><p>Info Blockquote</p></blockquote>
<blockquote class="warning"><p>Warning Blockquote</p></blockquote>
<blockquote class="danger"><p>Danger Blockquote</p></blockquote>
<blockquote class="success"><p>Success Blockquote</p></blockquote>
<h4>Customizations<a id="customizations" href="#customizations" class="heading-permalink" aria-hidden="true" title="Permalink">#</a></h4>
<p>You can easily customize these styles too by adding and editing the following in your <code>resources/app.css</code> file, and then recompiling your site styles.
The code examples here use the Tailwind <code>@apply</code> directives, but you could also use <code>border-color: blue;</code> just as well.</p>
Expand Down Expand Up @@ -438,7 +438,7 @@ <h4>Limitations<a id="limitations-2" href="#limitations-2" class="heading-permal
<div class="bg-white dark:bg-gray-800 rounded-lg shadow-lg p-4">
<header class="flex flex-row nowrap items-center justify-between">
<h3 class="text-lg font-bold mb-2 mr-3 flex">Documentation preview for&nbsp; <a href="https://github.com/hydephp/develop/pull/685" class="dark:text-indigo-400 text-indigo-500 hover:text-indigo-600">PR #685</a> &nbsp;
<small class="opacity-75">(#<a href="https://github.com/hydephp/develop/commit/947d7009e51a6e3acf64622f9246245b6c1bfcf1"><span style=" display: inline-flex; font-family: monospace; width: 7ch; white-space: nowrap; overflow: hidden; text-overflow: clip;">947d7009e51a6e3acf64622f9246245b6c1bfcf1</span></a>)</small>
<small class="opacity-75">(#<a href="https://github.com/hydephp/develop/commit/c30c22db2dad6d34db231ca06e75bdba0533da34"><span style=" display: inline-flex; font-family: monospace; width: 7ch; white-space: nowrap; overflow: hidden; text-overflow: clip;">c30c22db2dad6d34db231ca06e75bdba0533da34</span></a>)</small>
</h3>
<small class="mb-2">
<a href="https://github.com/hydephp/develop/pull/685" class="dark:text-indigo-400 text-indigo-500 hover:text-indigo-600">Back to PR</a>
Expand Down
8 changes: 4 additions & 4 deletions pr-685/dev-docs-preview/architecture-concepts.html
Original file line number Diff line number Diff line change
Expand Up @@ -351,15 +351,15 @@ <h3>Markdown<a id="markdown" href="#markdown" class="heading-permalink" aria-hid
Lorem ipsum dolor sit amet, etc.
</code></pre>
<h3>Blade<a id="blade" href="#blade" class="heading-permalink" aria-hidden="true" title="Permalink">#</a></h3>
<blockquote class="warning">🧪 This feature is experimental, and currently does not support multidimensional arrays or multi-line directives as the BladeMatter is statically parsed.</blockquote>
<blockquote class="warning"><p>🧪 This feature is experimental, and currently does not support multidimensional arrays or multi-line directives as the BladeMatter is statically parsed.</p></blockquote>
<p>Hyde v0.58.0-beta brings experimental support for creating front-matter in Blade templates, called BladeMatter. The actual syntax is does not use YAML; but instead PHP. However, the parsed end result is the same.</p>
<p>To create BladeMatter, you simply use the default Laravel Blade <code>@php</code> directive to declare a variable anywhere in the template.</p>
<p><strong>Example:</strong></p>
<pre><code class="language-blade">@php($title = 'BladeMatter Demo')
</code></pre>
<p>It will then be available through the global <code>$page</code> variable, <code>$page-&gt;matter('title')</code>.</p>
<h2>Automatic Routing<a id="automatic-routing" href="#automatic-routing" class="heading-permalink" aria-hidden="true" title="Permalink">#</a></h2>
<blockquote class="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.</blockquote>
<blockquote class="info"><p>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.</p></blockquote>
<h3>High-level overview<a id="high-level-overview" href="#high-level-overview" class="heading-permalink" aria-hidden="true" title="Permalink">#</a></h3>
<p>If you've ever worked in a MVC framework, you are probably familiar with the concept of routing. And you are probably also familiar with how boring and tedious it can be. Hyde takes the pain out of routing through the Hyde Autodiscovery process.</p>
<p>Internally, when booting the Hyde application, Hyde will automatically discover all of the content files in the source directory and create a routing index for them. This index works as a two-way link between source files and compiled files.</p>
Expand All @@ -378,7 +378,7 @@ <h3>Accessing routes<a id="accessing-routes" href="#accessing-routes" class="hea
// Compiled file: _site/docs/readme.html
Route::get('docs/readme')
</code></pre>
<blockquote class="info">Tip: You can also use "dot notation" instead of slashes, for example `Route::get('posts.my-post')`.</blockquote>
<blockquote class="info"><p>Tip: You can also use &quot;dot notation&quot; instead of slashes, for example <code>Route::get('posts.my-post')</code>.</p></blockquote>
<h3>Using the <code>x-link</code> component<a id="using-the-x-link-component" href="#using-the-x-link-component" class="heading-permalink" aria-hidden="true" title="Permalink">#</a></h3>
<p>When designing Blade layouts it can be useful to use the <code>x-link</code> component to automatically resolve relative links.</p>
<p>You can of course, use it just like a normal anchor tag like so:</p>
Expand Down Expand Up @@ -509,7 +509,7 @@ <h4>Documentation pages<a id="documentation-pages" href="#documentation-pages" c
<div class="bg-white dark:bg-gray-800 rounded-lg shadow-lg p-4">
<header class="flex flex-row nowrap items-center justify-between">
<h3 class="text-lg font-bold mb-2 mr-3 flex">Documentation preview for&nbsp; <a href="https://github.com/hydephp/develop/pull/685" class="dark:text-indigo-400 text-indigo-500 hover:text-indigo-600">PR #685</a> &nbsp;
<small class="opacity-75">(#<a href="https://github.com/hydephp/develop/commit/947d7009e51a6e3acf64622f9246245b6c1bfcf1"><span style=" display: inline-flex; font-family: monospace; width: 7ch; white-space: nowrap; overflow: hidden; text-overflow: clip;">947d7009e51a6e3acf64622f9246245b6c1bfcf1</span></a>)</small>
<small class="opacity-75">(#<a href="https://github.com/hydephp/develop/commit/c30c22db2dad6d34db231ca06e75bdba0533da34"><span style=" display: inline-flex; font-family: monospace; width: 7ch; white-space: nowrap; overflow: hidden; text-overflow: clip;">c30c22db2dad6d34db231ca06e75bdba0533da34</span></a>)</small>
</h3>
<small class="mb-2">
<a href="https://github.com/hydephp/develop/pull/685" class="dark:text-indigo-400 text-indigo-500 hover:text-indigo-600">Back to PR</a>
Expand Down
2 changes: 1 addition & 1 deletion pr-685/dev-docs-preview/autodiscovery.html
Original file line number Diff line number Diff line change
Expand Up @@ -364,7 +364,7 @@ <h3>The kernel lifecycle<a id="the-kernel-lifecycle" href="#the-kernel-lifecycle
<div class="bg-white dark:bg-gray-800 rounded-lg shadow-lg p-4">
<header class="flex flex-row nowrap items-center justify-between">
<h3 class="text-lg font-bold mb-2 mr-3 flex">Documentation preview for&nbsp; <a href="https://github.com/hydephp/develop/pull/685" class="dark:text-indigo-400 text-indigo-500 hover:text-indigo-600">PR #685</a> &nbsp;
<small class="opacity-75">(#<a href="https://github.com/hydephp/develop/commit/947d7009e51a6e3acf64622f9246245b6c1bfcf1"><span style=" display: inline-flex; font-family: monospace; width: 7ch; white-space: nowrap; overflow: hidden; text-overflow: clip;">947d7009e51a6e3acf64622f9246245b6c1bfcf1</span></a>)</small>
<small class="opacity-75">(#<a href="https://github.com/hydephp/develop/commit/c30c22db2dad6d34db231ca06e75bdba0533da34"><span style=" display: inline-flex; font-family: monospace; width: 7ch; white-space: nowrap; overflow: hidden; text-overflow: clip;">c30c22db2dad6d34db231ca06e75bdba0533da34</span></a>)</small>
</h3>
<small class="mb-2">
<a href="https://github.com/hydephp/develop/pull/685" class="dark:text-indigo-400 text-indigo-500 hover:text-indigo-600">Back to PR</a>
Expand Down
2 changes: 1 addition & 1 deletion pr-685/dev-docs-preview/automatic-routing.html
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ <h4 class="sidebar-group-heading text-base font-semibold mb-2 -ml-1">Advanced Fe
<div class="bg-white dark:bg-gray-800 rounded-lg shadow-lg p-4">
<header class="flex flex-row nowrap items-center justify-between">
<h3 class="text-lg font-bold mb-2 mr-3 flex">Documentation preview for&nbsp; <a href="https://github.com/hydephp/develop/pull/685" class="dark:text-indigo-400 text-indigo-500 hover:text-indigo-600">PR #685</a> &nbsp;
<small class="opacity-75">(#<a href="https://github.com/hydephp/develop/commit/947d7009e51a6e3acf64622f9246245b6c1bfcf1"><span style=" display: inline-flex; font-family: monospace; width: 7ch; white-space: nowrap; overflow: hidden; text-overflow: clip;">947d7009e51a6e3acf64622f9246245b6c1bfcf1</span></a>)</small>
<small class="opacity-75">(#<a href="https://github.com/hydephp/develop/commit/c30c22db2dad6d34db231ca06e75bdba0533da34"><span style=" display: inline-flex; font-family: monospace; width: 7ch; white-space: nowrap; overflow: hidden; text-overflow: clip;">c30c22db2dad6d34db231ca06e75bdba0533da34</span></a>)</small>
</h3>
<small class="mb-2">
<a href="https://github.com/hydephp/develop/pull/685" class="dark:text-indigo-400 text-indigo-500 hover:text-indigo-600">Back to PR</a>
Expand Down
2 changes: 1 addition & 1 deletion pr-685/dev-docs-preview/blog-posts.html
Original file line number Diff line number Diff line change
Expand Up @@ -517,7 +517,7 @@ <h2>Using images in posts<a id="using-images-in-posts" href="#using-images-in-po
<div class="bg-white dark:bg-gray-800 rounded-lg shadow-lg p-4">
<header class="flex flex-row nowrap items-center justify-between">
<h3 class="text-lg font-bold mb-2 mr-3 flex">Documentation preview for&nbsp; <a href="https://github.com/hydephp/develop/pull/685" class="dark:text-indigo-400 text-indigo-500 hover:text-indigo-600">PR #685</a> &nbsp;
<small class="opacity-75">(#<a href="https://github.com/hydephp/develop/commit/947d7009e51a6e3acf64622f9246245b6c1bfcf1"><span style=" display: inline-flex; font-family: monospace; width: 7ch; white-space: nowrap; overflow: hidden; text-overflow: clip;">947d7009e51a6e3acf64622f9246245b6c1bfcf1</span></a>)</small>
<small class="opacity-75">(#<a href="https://github.com/hydephp/develop/commit/c30c22db2dad6d34db231ca06e75bdba0533da34"><span style=" display: inline-flex; font-family: monospace; width: 7ch; white-space: nowrap; overflow: hidden; text-overflow: clip;">c30c22db2dad6d34db231ca06e75bdba0533da34</span></a>)</small>
</h3>
<small class="mb-2">
<a href="https://github.com/hydephp/develop/pull/685" class="dark:text-indigo-400 text-indigo-500 hover:text-indigo-600">Back to PR</a>
Expand Down
4 changes: 2 additions & 2 deletions pr-685/dev-docs-preview/collections.html
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ <h4 class="sidebar-group-heading text-base font-semibold mb-2 -ml-1">Advanced Fe
<h1>File-based Collections</h1>
</header>
<section id="document-main-content" itemprop="articleBody">
<blockquote class="info">This article covers advanced usage intended for those who are writing their own Blade views, and is not required as Hyde comes pre-packaged with many templates for you to use.</blockquote>
<blockquote class="info"><p>This article covers advanced usage intended for those who are writing their own Blade views, and is not required as Hyde comes pre-packaged with many templates for you to use.</p></blockquote>
<h2>Introduction to Hyde Data Collections<a id="introduction-to-hyde-data-collections" href="#introduction-to-hyde-data-collections" class="heading-permalink" aria-hidden="true" title="Permalink">#</a></h2>
<p>Hyde provides <code>DataCollections</code>, a subset of <a href="https://laravel.com/docs/9.x/collections">Laravel Collections</a> giving you a similar developer experience to working with Eloquent Collections, but here, it's all entirely file-based.</p>
<p>You get the have access to all Laravel Collection methods so you are encouraged to read the <a href="https://laravel.com/docs/9.x/collections">Laravel Collections documentation</a> for more information.</p>
Expand Down Expand Up @@ -360,7 +360,7 @@ <h4>Implementing it in a Blade view<a id="implementing-it-in-a-blade-view" href=
<div class="bg-white dark:bg-gray-800 rounded-lg shadow-lg p-4">
<header class="flex flex-row nowrap items-center justify-between">
<h3 class="text-lg font-bold mb-2 mr-3 flex">Documentation preview for&nbsp; <a href="https://github.com/hydephp/develop/pull/685" class="dark:text-indigo-400 text-indigo-500 hover:text-indigo-600">PR #685</a> &nbsp;
<small class="opacity-75">(#<a href="https://github.com/hydephp/develop/commit/947d7009e51a6e3acf64622f9246245b6c1bfcf1"><span style=" display: inline-flex; font-family: monospace; width: 7ch; white-space: nowrap; overflow: hidden; text-overflow: clip;">947d7009e51a6e3acf64622f9246245b6c1bfcf1</span></a>)</small>
<small class="opacity-75">(#<a href="https://github.com/hydephp/develop/commit/c30c22db2dad6d34db231ca06e75bdba0533da34"><span style=" display: inline-flex; font-family: monospace; width: 7ch; white-space: nowrap; overflow: hidden; text-overflow: clip;">c30c22db2dad6d34db231ca06e75bdba0533da34</span></a>)</small>
</h3>
<small class="mb-2">
<a href="https://github.com/hydephp/develop/pull/685" class="dark:text-indigo-400 text-indigo-500 hover:text-indigo-600">Back to PR</a>
Expand Down
Loading

0 comments on commit 568e100

Please sign in to comment.