feat: add documentation for configuration

1 files changed, 3 insertions, 0 deletions

diff --git a/src/index.ts b/src/index.ts
index 52e5581..2068d0f 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -4,7 +4,10 @@ import gemtextVitePlugin from "./vitePlugin.js"
 
 export const ext = "gmi"
 
+/** Gemtext configuration options */
 export interface GemtextConfig {
+    /** Absolute import path to the layout to use for all gemtext pages.
+     * If not provided, HMR and the Astro toolbar will not work. (default: none) */
     layout?: string
 }