Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge pull request #1812 from hydephp/documentation-fixes #91

Merged
merged 2 commits into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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
```

Expand All @@ -26,7 +24,6 @@ $page = new BaseMarkdownPage(string $identifier, Hyde\Markdown\Models\FrontMatte
Return the document's Markdown object.

```php
// torchlight! {"lineNumbers": false}
$page->markdown(): Hyde\Markdown\Models\Markdown
```

Expand All @@ -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.
```

Expand All @@ -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
```

Expand Down
3 changes: 0 additions & 3 deletions _docs/_data/partials/hyde-pages-api/blade-page-methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -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
```

Expand All @@ -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.
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
No description provided.

```php
// torchlight! {"lineNumbers": false}
DocumentationPage::home(): Hyde\Support\Models\Route
```

Expand All @@ -17,7 +16,6 @@ DocumentationPage::home(): Hyde\Support\Models\Route
No description provided.

```php
// torchlight! {"lineNumbers": false}
DocumentationPage::homeRouteName(): string
```

Expand All @@ -26,7 +24,6 @@ DocumentationPage::homeRouteName(): string
No description provided.

```php
// torchlight! {"lineNumbers": false}
DocumentationPage::hasTableOfContents(): bool
```

Expand All @@ -35,7 +32,6 @@ DocumentationPage::hasTableOfContents(): bool
No description provided.

```php
// torchlight! {"lineNumbers": false}
$page->getOnlineSourcePath(): string|false
```

Expand All @@ -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
```

Expand All @@ -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
```

Expand All @@ -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
```

Expand Down
3 changes: 0 additions & 3 deletions _docs/_data/partials/hyde-pages-api/html-page-methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
No description provided.

```php
// torchlight! {"lineNumbers": false}
$page->contents(): string
```

Expand All @@ -17,7 +16,6 @@ $page->contents(): string
No description provided.

```php
// torchlight! {"lineNumbers": false}
$page->compile(): string
```

Expand All @@ -26,7 +24,6 @@ $page->compile(): string
No description provided.

```php
// torchlight! {"lineNumbers": false}
$page->getBladeView(): string
```

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
<section id="hyde-kernel-base-methods">

<!-- Start generated docs for Hyde\Foundation\HydeKernel -->
<!-- Generated by HydePHP DocGen script at 2023-03-11 11:09:45 in 2.53ms -->
<!-- Generated by HydePHP DocGen script at 2024-07-08 20:47:38 in 2.89ms -->

#### `version()`

No description provided.

```php
// torchlight! {"lineNumbers": false}
Hyde::version(): string
```

Expand All @@ -17,7 +16,6 @@ Hyde::version(): string
No description provided.

```php
// torchlight! {"lineNumbers": false}
$hyde = new HydeKernel(string $basePath): void
```

Expand All @@ -26,7 +24,6 @@ $hyde = new HydeKernel(string $basePath): void
No description provided.

```php
// torchlight! {"lineNumbers": false}
Hyde::features(): Hyde\Facades\Features
```

Expand All @@ -35,16 +32,14 @@ Hyde::features(): Hyde\Facades\Features
No description provided.

```php
// torchlight! {"lineNumbers": false}
Hyde::hasFeature(Hyde\Enums\Feature $feature): bool
Hyde::hasFeature(Hyde\Enums\Feature|string $feature): bool
```

#### `toArray()`

Get the instance as an array.

```php
// torchlight! {"lineNumbers": false}
Hyde::toArray(): array<TKey, TValue>
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
Determine if the Kernel has booted.

```php
// torchlight! {"lineNumbers": false}
Hyde::isBooted(): bool
```

Expand All @@ -17,7 +16,6 @@ Hyde::isBooted(): bool
Boot the Hyde Kernel and run the Auto-Discovery Process.

```php
// torchlight! {"lineNumbers": false}
Hyde::boot(): void
```

Expand All @@ -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
```
Expand All @@ -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
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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
```

Expand All @@ -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
```

Expand All @@ -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>
```

Expand All @@ -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>>
```

Expand All @@ -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>>
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
No description provided.

```php
// torchlight! {"lineNumbers": false}
Hyde::filesystem(): Hyde\Foundation\Kernel\Filesystem
```

Expand All @@ -17,7 +16,6 @@ Hyde::filesystem(): Hyde\Foundation\Kernel\Filesystem
No description provided.

```php
// torchlight! {"lineNumbers": false}
Hyde::path(string $path): string
```

Expand All @@ -26,7 +24,6 @@ Hyde::path(string $path): string
No description provided.

```php
// torchlight! {"lineNumbers": false}
Hyde::vendorPath(string $path, string $package): string
```

Expand All @@ -35,7 +32,6 @@ Hyde::vendorPath(string $path, string $package): string
No description provided.

```php
// torchlight! {"lineNumbers": false}
Hyde::mediaPath(string $path): string
```

Expand All @@ -44,7 +40,6 @@ Hyde::mediaPath(string $path): string
No description provided.

```php
// torchlight! {"lineNumbers": false}
Hyde::sitePath(string $path): string
```

Expand All @@ -53,7 +48,6 @@ Hyde::sitePath(string $path): string
No description provided.

```php
// torchlight! {"lineNumbers": false}
Hyde::siteMediaPath(string $path): string
```

Expand All @@ -62,7 +56,6 @@ Hyde::siteMediaPath(string $path): string
No description provided.

```php
// torchlight! {"lineNumbers": false}
Hyde::pathToAbsolute(array|string $path): array|string
```

Expand All @@ -71,7 +64,6 @@ Hyde::pathToAbsolute(array|string $path): array|string
No description provided.

```php
// torchlight! {"lineNumbers": false}
Hyde::pathToRelative(string $path): string
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
No description provided.

```php
// torchlight! {"lineNumbers": false}
Hyde::files(): \Hyde\Foundation\Kernel\FileCollection<string, \Hyde\Support\Filesystem\ProjectFile>
```

Expand All @@ -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>
```

Expand All @@ -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>
```

Expand Down
Loading
Loading