Skip to content

Commit

Permalink
Allow URLs in option objects
Browse files Browse the repository at this point in the history
  • Loading branch information
cedx committed Apr 8, 2024
1 parent c594bf2 commit 128f2d7
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 6 deletions.
2 changes: 2 additions & 0 deletions etc/mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ extra_css:

markdown_extensions:
- admonition
- attr_list
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.superfences
Expand Down Expand Up @@ -67,6 +68,7 @@ theme:
- content.action.view
- content.code.copy
- content.tooltips
- navigation.footer
- navigation.instant
- navigation.instant.progress
- navigation.sections
Expand Down
3 changes: 1 addition & 2 deletions gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,9 @@ export function clean() {

// Builds the documentation.
export async function doc() {
for (const file of ["CHANGELOG.md", "LICENSE.md"]) await cp(file, `docs/${file.toLowerCase()}`);
await build();
await $`typedoc --options etc/typedoc.js`;
for (const file of ["CHANGELOG.md", "LICENSE.md"]) await cp(file, `docs/${file.toLowerCase()}`);
return cp("docs/favicon.ico", "docs/api/favicon.ico");
}

// Performs the static analysis of source code.
Expand Down
2 changes: 1 addition & 1 deletion src/author.ts
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ export interface AuthorOptions {
/**
* The URL of the author's website.
*/
url: string;
url: URL|string;

/**
* The author's user agent, that is the string identifying the Web browser used to submit comments.
Expand Down
2 changes: 1 addition & 1 deletion src/blog.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,5 +71,5 @@ export interface BlogOptions {
/**
* The blog or site URL.
*/
url: string;
url: URL|string;
}
4 changes: 2 additions & 2 deletions src/comment.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ export interface CommentOptions {
/**
* The permanent location of the entry the comment is submitted to.
*/
permalink: string;
permalink: URL|string;

/**
* The UTC timestamp of the publication time for the post, page or thread on which the comment was posted.
Expand All @@ -147,7 +147,7 @@ export interface CommentOptions {
/**
* The URL of the webpage that linked to the entry being requested.
*/
referrer: string;
referrer: URL|string;

/**
* The comment's type.
Expand Down

0 comments on commit 128f2d7

Please sign in to comment.