Refactor docs

rehypejs · Sep 1, 2023 · ddbbc18 · ddbbc18
1 parent ec8d99b
commit ddbbc18
Show file tree

Hide file tree

Showing 3 changed files with 501 additions and 464 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -9,7 +9,7 @@ export interface Image {
    */
   alt?: string | null | undefined
   /**
-   * Height of image (optional, example: '550').
+   * Height of image (optional, example: `'550'`).
    */
   height?: number | string | null | undefined
   /**
@@ -18,7 +18,7 @@ export interface Image {
    */
   url: string
   /**
-   * Width of image (optional, example: '1050').
+   * Width of image (optional, example: `'1050'`).
    */
   width?: number | string | null | undefined
 }
@@ -227,6 +227,7 @@ export interface Options {
   type?: 'article' | 'website' | null | undefined
 }
 
+// Add custom data supported when `rehype-meta` is added.
 declare module 'vfile' {
   interface DataMapMatter extends Options {}
   interface DataMapMeta extends Options {}