EssentialsLite Documentation Website

Official EssentialsLite documentation website package.

Contents

• Static app: index.html, assets/styles.css, assets/app.js.
• Expandable docs: docs/**/*.emd.
• Documentation index: docs/manifest.json.
• Reference data: data/commands.json, data/permissions.json, data/config-index.json.
• Raw default references: data/default-config.yml, data/custom-commands-example.yml, data/plugin.yml, data/redis.yml, data/menus.yml, data/rtp-zones.yml.
• Local test server: scripts/serve-local.mjs.
• Release validation: npm run check.

Local preview

Do not open index.html directly with file://. Browsers block local fetch() calls for .emd and JSON files.

Use the built-in Node server:

npm run dev

Open:

http://127.0.0.1:8080/

Use another port:

PORT=4173 npm run dev

Release validation

Run before publishing:

npm run check

This performs:

1. Documentation index update.
2. Static file/data validation.
3. Local HTTP smoke test against the bundled server.

Add docs

1. Add a .emd file under docs/.
2. Include frontmatter:

---
title: My Page
section: Features
order: 99
description: Search result description.
tags: commands config permissions
---

3. Run:

npm run build:manifest
npm run check

4. Commit and push.

GitHub Pages

This site uses relative paths and includes .nojekyll, so it can be deployed at a project URL such as /page/ or under a custom domain.

Recommended repository: essentialslite/page.

Responsive design notes

The layout is built around three breakpoints:

• Desktop: sidebar + content + right rail.
• Tablet: sidebar + content, right rail removed.
• Mobile: drawer navigation, full-width search, scroll-safe tables.

Long commands, permissions, config keys, and code blocks use overflow guards so they do not overlap the viewport.