summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoraspizu <aspizu@protonmail.com>2025-03-10 03:37:47 +0530
committeraspizu <aspizu@protonmail.com>2025-03-10 03:37:47 +0530
commit663aceceb4ff576b4b4c1765434e426c55ebb6fb (patch)
treecb6619e74e50790d18937ed7f7590a450f8fc2c6 /README.md
parente6af7e70d05fe89be3b3b5a584a094edd1342b56 (diff)
docs: update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
index e7a79ec..f1f566a 100644
--- a/README.md
+++ b/README.md
@@ -7,3 +7,33 @@
```
bun add --save astro-gemtext
```
+
+Add to `astro.config.mjs`
+
+```ts
+import gemtext from "astro-gemtext"
+
+export default defineConfig({
+ integrations: [gemtext({layout: "/src/layouts/Layout.astro"})],
+})
+```
+
+## Usage
+
+Create a `/src/pages/example.gmi` file
+
+```gmi
+# Hello World
+
+This is a gemtext file.
+
+=> gemtext.gemini README.md
+```
+
+## Configuration
+
+### `layout`
+
+The layout to use for the page. Set to an absolute import path such as
+`/src/layouts/Layout.astro`. If you do not use a layout, you will not get HMR, or the
+Astro toolbar.