-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
88 changed files
with
1,762 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [AssetSpec](./imgit.assetspec.md) | ||
|
||
## AssetSpec type | ||
|
||
Per-asset specifications assigned by the user. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export type AssetSpec = { | ||
width?: number; | ||
eager?: boolean; | ||
merge?: boolean; | ||
media?: string; | ||
class?: string; | ||
}; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [AssetSyntax](./imgit.assetsyntax.md) | ||
|
||
## AssetSyntax type | ||
|
||
Asset syntax captured from transformed document. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export type AssetSyntax = { | ||
text: string; | ||
index: number; | ||
url: string; | ||
alt?: string; | ||
spec?: string; | ||
}; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [boot](./imgit.boot.md) | ||
|
||
## boot() function | ||
|
||
Initializes build context with specified options. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export declare function boot(prefs?: Prefs, platform?: Platform): Promise<void>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| prefs | [Prefs](./imgit.prefs.md) | _(Optional)_ Build preferences; will use pre-defined defaults when not assigned. | | ||
| platform | [Platform](./imgit.platform.md) | _(Optional)_ Runtime APIs to use; will attempt to detect automatically when not assigned. | | ||
|
||
**Returns:** | ||
|
||
Promise<void> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [build](./imgit.build.md) > [build](./imgit.build.build.md) | ||
|
||
## build.build() function | ||
|
||
Default HTML builder for supported asset types (images and video). | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export declare function build(asset: BuiltAsset, merges?: BuiltAsset[]): Promise<void>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| asset | [BuiltAsset](./imgit.builtasset.md) | | | ||
| merges | [BuiltAsset](./imgit.builtasset.md)<!-- -->\[\] | _(Optional)_ | | ||
|
||
**Returns:** | ||
|
||
Promise<void> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [build](./imgit.build.md) > [buildAll](./imgit.build.buildall.md) | ||
|
||
## build.buildAll() function | ||
|
||
Builds HTML for the optimized assets to overwrite source syntax. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export declare function buildAll(assets: EncodedAsset[]): Promise<BuiltAsset[]>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| assets | [EncodedAsset](./imgit.encodedasset.md)<!-- -->\[\] | | | ||
|
||
**Returns:** | ||
|
||
Promise<[BuiltAsset](./imgit.builtasset.md)<!-- -->\[\]> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [build](./imgit.build.md) > [buildContentSource](./imgit.build.buildcontentsource.md) | ||
|
||
## build.buildContentSource() function | ||
|
||
Builds serve url for content file with specified full path based on configured root option. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export declare function buildContentSource(path: string): string; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| path | string | | | ||
|
||
**Returns:** | ||
|
||
string | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [build](./imgit.build.md) > [CONTAINER\_ATTR](./imgit.build.container_attr.md) | ||
|
||
## build.CONTAINER\_ATTR variable | ||
|
||
Attribute expected on containers of HTML generated for imgit content. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
CONTAINER_ATTR = "data-imgit-container" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [build](./imgit.build.md) > [COVER\_CONTAINED\_STYLE](./imgit.build.cover_contained_style.md) | ||
|
||
## build.COVER\_CONTAINED\_STYLE variable | ||
|
||
CSS style applied to contained elements, siblings to cover element. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
COVER_CONTAINED_STYLE = "width:100%;" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [build](./imgit.build.md) > [COVER\_CONTAINER\_STYLE](./imgit.build.cover_container_style.md) | ||
|
||
## build.COVER\_CONTAINER\_STYLE variable | ||
|
||
CSS style applied to container of cover element. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
COVER_CONTAINER_STYLE = "display:flex;" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [build](./imgit.build.md) > [COVER\_STYLE](./imgit.build.cover_style.md) | ||
|
||
## build.COVER\_STYLE variable | ||
|
||
CSS style applied to cover element itself. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
COVER_STYLE = "width:100%;margin-left:-100%;" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [build](./imgit.build.md) > [LOADABLE\_ATTR](./imgit.build.loadable_attr.md) | ||
|
||
## build.LOADABLE\_ATTR variable | ||
|
||
Attribute expected on HTML elements loaded by imgit. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
LOADABLE_ATTR = "data-imgit-loadable" | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [build](./imgit.build.md) | ||
|
||
## build namespace | ||
|
||
## Functions | ||
|
||
| Function | Description | | ||
| --- | --- | | ||
| [build(asset, merges)](./imgit.build.build.md) | Default HTML builder for supported asset types (images and video). | | ||
| [buildAll(assets)](./imgit.build.buildall.md) | Builds HTML for the optimized assets to overwrite source syntax. | | ||
| [buildContentSource(path)](./imgit.build.buildcontentsource.md) | Builds serve url for content file with specified full path based on configured root option. | | ||
|
||
## Variables | ||
|
||
| Variable | Description | | ||
| --- | --- | | ||
| [CONTAINER\_ATTR](./imgit.build.container_attr.md) | Attribute expected on containers of HTML generated for imgit content. | | ||
| [COVER\_CONTAINED\_STYLE](./imgit.build.cover_contained_style.md) | CSS style applied to contained elements, siblings to cover element. | | ||
| [COVER\_CONTAINER\_STYLE](./imgit.build.cover_container_style.md) | CSS style applied to container of cover element. | | ||
| [COVER\_STYLE](./imgit.build.cover_style.md) | CSS style applied to cover element itself. | | ||
| [LOADABLE\_ATTR](./imgit.build.loadable_attr.md) | Attribute expected on HTML elements loaded by imgit. | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [build\_2](./imgit.build_2.md) | ||
|
||
## build\_2() function | ||
|
||
Default HTML builder for supported asset types (images and video). | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export declare function build(asset: BuiltAsset, merges?: BuiltAsset[]): Promise<void>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| asset | [BuiltAsset](./imgit.builtasset.md) | | | ||
| merges | [BuiltAsset](./imgit.builtasset.md)<!-- -->\[\] | _(Optional)_ | | ||
|
||
**Returns:** | ||
|
||
Promise<void> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [buildAll](./imgit.buildall.md) | ||
|
||
## buildAll() function | ||
|
||
Builds HTML for the optimized assets to overwrite source syntax. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export declare function buildAll(assets: EncodedAsset[]): Promise<BuiltAsset[]>; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| assets | [EncodedAsset](./imgit.encodedasset.md)<!-- -->\[\] | | | ||
|
||
**Returns:** | ||
|
||
Promise<[BuiltAsset](./imgit.builtasset.md)<!-- -->\[\]> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [buildContentSource](./imgit.buildcontentsource.md) | ||
|
||
## buildContentSource() function | ||
|
||
Builds serve url for content file with specified full path based on configured root option. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export declare function buildContentSource(path: string): string; | ||
``` | ||
|
||
## Parameters | ||
|
||
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| path | string | | | ||
|
||
**Returns:** | ||
|
||
string | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [BuiltAsset](./imgit.builtasset.md) | ||
|
||
## BuiltAsset type | ||
|
||
Final product of asset transformation with associated HTML. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export type BuiltAsset = EncodedAsset & { | ||
html: string; | ||
}; | ||
``` | ||
**References:** [EncodedAsset](./imgit.encodedasset.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [cache](./imgit.cache.md) | ||
|
||
## cache variable | ||
|
||
Cached results of the build operations. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
cache: Cache | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [Cache\_2](./imgit.cache_2.md) | ||
|
||
## Cache\_2 type | ||
|
||
Cached results of the build operations. Each property is persisted as a standalone JSON file between build runs. Custom properties can be added. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export type Cache = Record<string, unknown> & { | ||
sizes: Record<string, number>; | ||
probes: Record<string, ContentInfo>; | ||
specs: Record<string, EncodeSpec>; | ||
covers: Record<string, string>; | ||
}; | ||
``` | ||
**References:** [ContentInfo](./imgit.contentinfo.md)<!-- -->, [EncodeSpec](./imgit.encodespec.md) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [imgit](./imgit.md) > [CacheOptions](./imgit.cacheoptions.md) | ||
|
||
## CacheOptions type | ||
|
||
Configures server cache. | ||
|
||
**Signature:** | ||
|
||
```typescript | ||
export type CacheOptions = { | ||
root: string; | ||
}; | ||
``` |
Oops, something went wrong.