Merge pull request #1812 from hydephp/documentation-fixes

Clean up the documentation hydephp/develop@0824579
hydephp · Jul 8, 2024 · cb09f85 · cb09f85
1 parent 2124bea
commit cb09f85
Show file tree

Hide file tree

Showing 24 changed files with 11 additions and 204 deletions.
diff --git a/_docs/_data/partials/hyde-pages-api/base-markdown-page-methods.md b/_docs/_data/partials/hyde-pages-api/base-markdown-page-methods.md
@@ -8,7 +8,6 @@
 Create a new page instance. Static alias for the constructor.
 
 ```php
-// torchlight! {"lineNumbers": false}
 BaseMarkdownPage::make(string $identifier, Hyde\Markdown\Models\FrontMatter|array $matter, Hyde\Markdown\Models\Markdown|string $markdown): static
 ```
 
@@ -17,7 +16,6 @@ BaseMarkdownPage::make(string $identifier, Hyde\Markdown\Models\FrontMatter|arra
 Construct a new page instance.
 
 ```php
-// torchlight! {"lineNumbers": false}
 $page = new BaseMarkdownPage(string $identifier, Hyde\Markdown\Models\FrontMatter|array $matter, Hyde\Markdown\Models\Markdown|string $markdown): void
 ```
 
@@ -26,7 +24,6 @@ $page = new BaseMarkdownPage(string $identifier, Hyde\Markdown\Models\FrontMatte
 Return the document&#039;s Markdown object.
 
 ```php
-// torchlight! {"lineNumbers": false}
 $page->markdown(): Hyde\Markdown\Models\Markdown
 ```
 
@@ -35,7 +32,6 @@ $page->markdown(): Hyde\Markdown\Models\Markdown
 Compile the page into static HTML.
 
 ```php
-// torchlight! {"lineNumbers": false}
 $page->compile(): string // The compiled HTML for the page.
 ```
 
@@ -44,7 +40,6 @@ $page->compile(): string // The compiled HTML for the page.
 Save the Markdown page object to disk by compiling the front matter array to YAML and writing the body to the file.
 
 ```php
-// torchlight! {"lineNumbers": false}
 $page->save(): $this
 ```
 

diff --git a/_docs/_data/partials/hyde-pages-api/blade-page-methods.md b/_docs/_data/partials/hyde-pages-api/blade-page-methods.md
@@ -8,7 +8,6 @@
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 /** @param string $identifier The identifier, which also serves as the view key. */
 $page = new BladePage(string $identifier, Hyde\Markdown\Models\FrontMatter|array $matter): void
 ```
@@ -18,7 +17,6 @@ $page = new BladePage(string $identifier, Hyde\Markdown\Models\FrontMatter|array
 Get the Blade template/view key for the page.
 
 ```php
-// torchlight! {"lineNumbers": false}
 $page->getBladeView(): string
 ```
 
@@ -27,7 +25,6 @@ $page->getBladeView(): string
 Compile the page into static HTML.
 
 ```php
-// torchlight! {"lineNumbers": false}
 $page->compile(): string // The compiled HTML for the page.
 ```
 

diff --git a/_docs/_data/partials/hyde-pages-api/documentation-page-methods.md b/_docs/_data/partials/hyde-pages-api/documentation-page-methods.md
@@ -8,7 +8,6 @@
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 DocumentationPage::home(): Hyde\Support\Models\Route
 ```
 
@@ -17,7 +16,6 @@ DocumentationPage::home(): Hyde\Support\Models\Route
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 DocumentationPage::homeRouteName(): string
 ```
 
@@ -26,7 +24,6 @@ DocumentationPage::homeRouteName(): string
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 DocumentationPage::hasTableOfContents(): bool
 ```
 
@@ -35,7 +32,6 @@ DocumentationPage::hasTableOfContents(): bool
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 $page->getOnlineSourcePath(): string|false
 ```
 
@@ -44,7 +40,6 @@ $page->getOnlineSourcePath(): string|false
 Generate Table of Contents as HTML from a Markdown document body.
 
 ```php
-// torchlight! {"lineNumbers": false}
 $page->getTableOfContents(): string
 ```
 
@@ -55,7 +50,6 @@ Get the route key for the page.
 If flattened outputs are enabled, this will use the identifier basename so nested pages are flattened.
 
 ```php
-// torchlight! {"lineNumbers": false}
 $page->getRouteKey(): string
 ```
 
@@ -66,7 +60,6 @@ Get the path where the compiled page will be saved.
 If flattened outputs are enabled, this will use the identifier basename so nested pages are flattened.
 
 ```php
-// torchlight! {"lineNumbers": false}
 $page->getOutputPath(): string
 ```
 

diff --git a/_docs/_data/partials/hyde-pages-api/html-page-methods.md b/_docs/_data/partials/hyde-pages-api/html-page-methods.md
@@ -8,7 +8,6 @@
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 $page->contents(): string
 ```
 
@@ -17,7 +16,6 @@ $page->contents(): string
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 $page->compile(): string
 ```
 
@@ -26,7 +24,6 @@ $page->compile(): string
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 $page->getBladeView(): string
 ```
 

diff --git a/_docs/_data/partials/hyde-pages-api/hyde-kernel-base-methods.md b/_docs/_data/partials/hyde-pages-api/hyde-kernel-base-methods.md
@@ -8,7 +8,6 @@
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::version(): string
 ```
 
@@ -17,7 +16,6 @@ Hyde::version(): string
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 $hyde = new HydeKernel(string $basePath): void
 ```
 
@@ -26,7 +24,6 @@ $hyde = new HydeKernel(string $basePath): void
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::features(): Hyde\Facades\Features
 ```
 
@@ -35,7 +32,6 @@ Hyde::features(): Hyde\Facades\Features
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::hasFeature(Hyde\Enums\Feature $feature): bool
 ```
 
@@ -44,7 +40,6 @@ Hyde::hasFeature(Hyde\Enums\Feature $feature): bool
 Get the instance as an array.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::toArray(): array<TKey, TValue>
 ```
 

diff --git a/_docs/_data/partials/hyde-pages-api/hyde-kernel-boot-methods.md b/_docs/_data/partials/hyde-pages-api/hyde-kernel-boot-methods.md
@@ -8,7 +8,6 @@
 Determine if the Kernel has booted.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::isBooted(): bool
 ```
 
@@ -17,7 +16,6 @@ Hyde::isBooted(): bool
 Boot the Hyde Kernel and run the Auto-Discovery Process.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::boot(): void
 ```
 
@@ -28,7 +26,6 @@ Register a new boot listener.
 Your callback will be called before the kernel is booted. You can use this to register your own routes, pages, etc. The kernel instance will be passed to your callback.
 
 ```php
-// torchlight! {"lineNumbers": false}
 /** @param callable(\Hyde\Foundation\HydeKernel): void $callback */
 Hyde::booting(callable(\Hyde\Foundation\HydeKernel): void): void
 ```
@@ -40,7 +37,6 @@ Register a new &quot;booted&quot; listener.
 Your callback will be called after the kernel is booted. You can use this to run any logic after discovery has completed. The kernel instance will be passed to your callback.
 
 ```php
-// torchlight! {"lineNumbers": false}
 /** @param callable(\Hyde\Foundation\HydeKernel): void $callback */
 Hyde::booted(callable(\Hyde\Foundation\HydeKernel): void): void
 ```

diff --git a/_docs/_data/partials/hyde-pages-api/hyde-kernel-extensions-methods.md b/_docs/_data/partials/hyde-pages-api/hyde-kernel-extensions-methods.md
@@ -10,7 +10,6 @@ Register a HydePHP extension within the HydeKernel.
 Typically, you would call this method in the register method of a service provider. If your package uses the standard Laravel (Composer) package discovery feature, the extension will automatically be enabled when the package is installed.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::registerExtension(class-string&lt;\Hyde\Foundation\Concerns\HydeExtension&gt; $extension): void
 ```
 
@@ -19,7 +18,6 @@ Hyde::registerExtension(class-string&lt;\Hyde\Foundation\Concerns\HydeExtension&
 Get the singleton instance of the specified extension.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::getExtension(class-string&lt;T&gt; $extension): T
 ```
 
@@ -28,7 +26,6 @@ Hyde::getExtension(class-string&lt;T&gt; $extension): T
 Determine if the specified extension is registered.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::hasExtension(class-string&lt;\Hyde\Foundation\Concerns\HydeExtension&gt; $extension): bool
 ```
 
@@ -37,7 +34,6 @@ Hyde::hasExtension(class-string&lt;\Hyde\Foundation\Concerns\HydeExtension&gt; $
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::getExtensions(): array<\Hyde\Foundation\Concerns\HydeExtension>
 ```
 
@@ -46,7 +42,6 @@ Hyde::getExtensions(): array<\Hyde\Foundation\Concerns\HydeExtension>
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::getRegisteredExtensions(): array<class-string<\Hyde\Foundation\Concerns\HydeExtension>>
 ```
 
@@ -55,7 +50,6 @@ Hyde::getRegisteredExtensions(): array<class-string<\Hyde\Foundation\Concerns\Hy
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::getRegisteredPageClasses(): array<class-string<\Hyde\Pages\Concerns\HydePage>>
 ```
 

diff --git a/_docs/_data/partials/hyde-pages-api/hyde-kernel-filesystem-methods.md b/_docs/_data/partials/hyde-pages-api/hyde-kernel-filesystem-methods.md
@@ -8,7 +8,6 @@
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::filesystem(): Hyde\Foundation\Kernel\Filesystem
 ```
 
@@ -17,7 +16,6 @@ Hyde::filesystem(): Hyde\Foundation\Kernel\Filesystem
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::path(string $path): string
 ```
 
@@ -26,7 +24,6 @@ Hyde::path(string $path): string
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::vendorPath(string $path, string $package): string
 ```
 
@@ -35,7 +32,6 @@ Hyde::vendorPath(string $path, string $package): string
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::mediaPath(string $path): string
 ```
 
@@ -44,7 +40,6 @@ Hyde::mediaPath(string $path): string
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::sitePath(string $path): string
 ```
 
@@ -53,7 +48,6 @@ Hyde::sitePath(string $path): string
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::siteMediaPath(string $path): string
 ```
 
@@ -62,7 +56,6 @@ Hyde::siteMediaPath(string $path): string
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::pathToAbsolute(array|string $path): array|string
 ```
 
@@ -71,7 +64,6 @@ Hyde::pathToAbsolute(array|string $path): array|string
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::pathToRelative(string $path): string
 ```
 

diff --git a/_docs/_data/partials/hyde-pages-api/hyde-kernel-foundation-methods.md b/_docs/_data/partials/hyde-pages-api/hyde-kernel-foundation-methods.md
@@ -8,7 +8,6 @@
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::files(): \Hyde\Foundation\Kernel\FileCollection<string, \Hyde\Support\Filesystem\ProjectFile>
 ```
 
@@ -17,7 +16,6 @@ Hyde::files(): \Hyde\Foundation\Kernel\FileCollection<string, \Hyde\Support\File
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::pages(): \Hyde\Foundation\Kernel\PageCollection<string, \Hyde\Pages\Concerns\HydePage>
 ```
 
@@ -26,7 +24,6 @@ Hyde::pages(): \Hyde\Foundation\Kernel\PageCollection<string, \Hyde\Pages\Concer
 No description provided.
 
 ```php
-// torchlight! {"lineNumbers": false}
 Hyde::routes(): \Hyde\Foundation\Kernel\RouteCollection<string, \Hyde\Support\Models\Route>
 ```