README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# `astro-gemtext`

![https://www.npmjs.com/package/astro-gemtext](https://img.shields.io/npm/dm/astro-gemtext)

## Installation

```
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.