diff --git a/etc/mkdocs.yaml b/etc/mkdocs.yaml index 875ced73..b377bb66 100644 --- a/etc/mkdocs.yaml +++ b/etc/mkdocs.yaml @@ -31,6 +31,7 @@ extra_css: markdown_extensions: - admonition + - attr_list - pymdownx.highlight - pymdownx.inlinehilite - pymdownx.superfences @@ -67,6 +68,7 @@ theme: - content.action.view - content.code.copy - content.tooltips + - navigation.footer - navigation.instant - navigation.instant.progress - navigation.sections diff --git a/gulpfile.js b/gulpfile.js index fa1f641c..ce2731ea 100644 --- a/gulpfile.js +++ b/gulpfile.js @@ -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. diff --git a/src/author.ts b/src/author.ts index 6b26f35a..60837a22 100644 --- a/src/author.ts +++ b/src/author.ts @@ -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. diff --git a/src/blog.ts b/src/blog.ts index 1c6ee23a..f9a1f4bd 100644 --- a/src/blog.ts +++ b/src/blog.ts @@ -71,5 +71,5 @@ export interface BlogOptions { /** * The blog or site URL. */ - url: string; + url: URL|string; } diff --git a/src/comment.ts b/src/comment.ts index 3d8d73ef..1f97f75b 100644 --- a/src/comment.ts +++ b/src/comment.ts @@ -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. @@ -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.