etydotonl/README.md

# ety.onl

This repo contains the handwritten source files for the [Eleventy](https://www.11ty.dev/)-powered site at [ety.onl](https://ety.onl), and this README contains notes to myself concerning maintaining the site.

Though this repo is mostly intended for my own use, if you happened to stumble in here, please feel free to make use of whatever you might find.

## Key Files

| File | Description |
| --- | --- |
| `eleventy.config.js` | 11ty generator setup; passthroughs, filters, etc. |
| `src/_data/site.json` | Global site data; title, nav links |
| `src/_data/includes/base.njk` | Primary site page template |
| `src/_data/partials/*.njk` | Header, footer, partial templates |
| `src/assets/` | copied as-is; CSS, images, js, copied as-is |
| `src/public/` | copied as-is; root files: favicon, robots.txt, etc |

## Adding a new page

1. Create a new file, e.g., `src/page.md` with the front matter such as:

```yaml
–––
title: Cool Page
description: Does whatever a cool page does
permalink: /page/
–––
```

2. If the new page should be included in the nav, add it to `src/_data/site.json`.

## Front Matter Notes
* `title` - Shown in page title and title bar
* `description` - Page-specific meta description; uses site default if not specified
* `layout: layouts/base.njk` - (optional) override for layout template
* `permalink` - optional, override 11ty path generating behavior with pretty slug
* `draft: true` - Set on incomplete articles to exclude from 11ty build

## RSS Feed

Pending.

## Gemtext Build

Pending.

## Other Notes

`etydotonl` will automatically build, validate, and deploy code upon each commit to `main`. Failing builds will not deploy.