Skip to content

Commit

Permalink
Merge pull request #49 from phun-ky/docs/update
Browse files Browse the repository at this point in the history
docs: ✏️ Do not generate docs from tests
  • Loading branch information
phun-ky committed Feb 27, 2024
2 parents 549a277 + ebbde94 commit 7a3cd1a
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 11 deletions.
10 changes: 0 additions & 10 deletions api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,6 @@
- [features/dom](modules/features_dom.md)
- [main](modules/main.md)
- [types](modules/types.md)
- [utils/\_\_tests\_\_/blob](modules/utils___tests___blob.md)
- [utils/\_\_tests\_\_/code](modules/utils___tests___code.md)
- [utils/\_\_tests\_\_/css](modules/utils___tests___css.md)
- [utils/\_\_tests\_\_/headers](modules/utils___tests___headers.md)
- [utils/\_\_tests\_\_/iframe](modules/utils___tests___iframe.md)
- [utils/\_\_tests\_\_/js](modules/utils___tests___js.md)
- [utils/\_\_tests\_\_/source](modules/utils___tests___source.md)
- [utils/\_\_tests\_\_/style](modules/utils___tests___style.md)
- [utils/\_\_tests\_\_/styles](modules/utils___tests___styles.md)
- [utils/\_\_tests\_\_/wait](modules/utils___tests___wait.md)
- [utils/blob](modules/utils_blob.md)
- [utils/code](modules/utils_code.md)
- [utils/create](modules/utils_create.md)
Expand Down
38 changes: 38 additions & 0 deletions api/modules/constants.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
[@phun-ky/frameport](../README.md) / constants

# Module: constants

## Variables

### DEFAULT\_HEADERS

`Const` **DEFAULT\_HEADERS**: `string`[]

Default meta headers for an HTML document.

#### Defined in

[constants/index.ts:27](https://github.com/phun-ky/frameport/blob/main/src/constants/index.ts#L27)

___

### HIDE\_TEMPLATE\_STYLE

`Const` **HIDE\_TEMPLATE\_STYLE**: `Object`

Style object for hiding an element in the HTML.

#### Type declaration

| Name | Type |
| :------ | :------ |
| `clip` | `string` |
| `height` | `string` |
| `margin` | `string` |
| `overflow` | `string` |
| `position` | `string` |
| `width` | `string` |

#### Defined in

[constants/index.ts:6](https://github.com/phun-ky/frameport/blob/main/src/constants/index.ts#L6)
9 changes: 8 additions & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,12 @@
"esModuleInterop": true,
"resolveJsonModule": true
},
"exclude": ["node_modules", "build", "dist", "scripts", "dts"]
"exclude": [
"node_modules",
"build",
"dist",
"scripts",
"dts",
"**/__tests__/**"
]
}

0 comments on commit 7a3cd1a

Please sign in to comment.