@axerity/cli 0.1.4 → 0.2.1

package/src/content/demo/components/video.md

@@ -1,56 +0,0 @@
----
-title: Video
-description: Embed a YouTube video in a responsive player.
-icon: play
----
-
-<script>
-	import { Video } from '$lib';
-</script>
-
-# Video
-
-The `Video` component renders a responsive 16:9 player. It works with hosted
-files and with the common providers, and picks the right player for whatever you
-give it:
-
-- A direct video file (`.mp4`, `.webm`, `.ogg`, `.mov`, `.m4v`) plays in the
-  browser's native player.
-- A YouTube link or id embeds through the privacy friendly `youtube-nocookie`
-  host.
-- A Vimeo link embeds through the Vimeo player.
-
-## YouTube
-
-<Video src="https://youtu.be/oRdxUFDoQe0" title="Michael Jackson - Beat It" />
-
-A full watch link, a short `youtu.be` link, or a bare video id all work:
-
-```svelte
-<Video src="https://youtu.be/oRdxUFDoQe0" title="Michael Jackson - Beat It" />
-<Video src="https://www.youtube.com/watch?v=oRdxUFDoQe0" />
-<Video src="oRdxUFDoQe0" />
-```
-
-## Hosted file
-
-Point `src` at a video file and it plays inline with native controls. Pass
-`poster` for a still frame to show before playback:
-
-```svelte
-<Video src="/media/demo.mp4" poster="/media/demo-poster.jpg" title="Product demo" />
-```
-
-## Vimeo
-
-```svelte
-<Video src="https://vimeo.com/76979871" title="Vimeo example" />
-```
-
-## Props
-
-| Prop     | Type     | Description                                      |
-| -------- | -------- | ------------------------------------------------ |
-| `src`    | `string` | File URL, provider URL, or YouTube id (required) |
-| `title`  | `string` | Label for screen readers (default `Video`)       |
-| `poster` | `string` | Still frame for hosted files, shown before play  |

package/src/content/demo/components/webhooks.md

@@ -1,109 +0,0 @@
----
-title: Webhooks
-description: Document the events your API sends to a customer's endpoint.
-icon: webhook
----
-
-<script>
-	import { Webhook, EventList, Event, ResponseField, ResponseExample } from '$lib';
-</script>
-
-# Webhooks
-
-Webhook docs read differently from endpoints: you are documenting an event your
-service sends to the customer's server. The `Webhook` component lays out the
-event, its payload, and an example, with the same sticky rail as the API kit.
-
-## An event
-
-<Webhook event="invoice.paid" method="POST" description="Sent when an invoice is paid in full.">
-
-## Payload
-
-<ResponseField name="id" type="string">
-
-Unique id for the event.
-
-</ResponseField>
-
-<ResponseField name="type" type="string">
-
-The event type, always `invoice.paid` here.
-
-</ResponseField>
-
-<ResponseField name="data" type="object">
-
-The invoice that was paid.
-
-</ResponseField>
-
-<ResponseExample title="Example event">
-
-```json
-{
-	"id": "evt_1abc",
-	"type": "invoice.paid",
-	"data": { "id": "in_9xy", "amount": 4200, "currency": "usd" }
-}
-```
-
-</ResponseExample>
-
-</Webhook>
-
-## Usage
-
-Wrap the event in `<Webhook>` and document the payload with `ResponseField`, then
-add a `ResponseExample` (or `ObjectExample`) with a fenced code block for the
-sample event:
-
-```svelte
-<Webhook event="invoice.paid" method="POST" description="Sent when an invoice is paid.">
-	## Payload
-
-	<ResponseField name="id" type="string">Unique id for the event.</ResponseField>
-
-	<ResponseExample title="Example event">
-		(a fenced json block with the sample payload)
-	</ResponseExample>
-</Webhook>
-```
-
-It works just like the [API components](/components/api), so any of
-`ResponseField`, `ResponseExample`, and `ObjectExample` are available inside.
-
-## Listing events
-
-`EventList` renders an index of every event you send. Link each one to its
-detail page.
-
-<EventList>
-	<Event name="invoice.paid" href="/components/webhooks">An invoice was paid in full.</Event>
-	<Event name="invoice.payment_failed" href="/components/webhooks">A payment attempt failed.</Event>
-	<Event name="customer.created" href="/components/webhooks">A new customer was created.</Event>
-</EventList>
-
-```svelte
-<EventList>
-	<Event name="invoice.paid" href="/webhooks/invoice-paid">An invoice was paid.</Event>
-	<Event name="customer.created" href="/webhooks/customer-created">A customer was created.</Event>
-</EventList>
-```
-
-## Props
-
-### Webhook
-
-| Prop          | Type     | Description                           |
-| ------------- | -------- | ------------------------------------- |
-| `event`       | `string` | The event type, e.g. `invoice.paid`   |
-| `method`      | `string` | Delivery method (default `POST`)      |
-| `description` | `string` | Short summary of when the event fires |
-
-### Event
-
-| Prop   | Type     | Description                     |
-| ------ | -------- | ------------------------------- |
-| `name` | `string` | The event type (required)       |
-| `href` | `string` | Link to the event's detail page |

package/src/content/demo/components/websockets.md

@@ -1,101 +0,0 @@
----
-title: WebSockets
-description: Document channels and messages for WebSocket and AsyncAPI services.
-icon: radio
----
-
-<script>
-	import { Channel, Message, ResponseField, ResponseExample } from '$lib';
-</script>
-
-# WebSockets
-
-Event-driven APIs are documented as channels and messages, not requests and
-responses. `Channel` lays out a connection and its messages with the same sticky
-rail as the API kit, and `Message` marks the direction of each one.
-
-## A channel
-
-<Channel address={'/chat/{roomId}'} protocol="wss" server="wss://api.example.com" description="Real-time chat for a room.">
-
-<Message direction="receive" name="message.created">
-
-A new chat message arrived.
-
-## Payload
-
-<ResponseField name="id" type="string">
-
-Unique id for the message.
-
-</ResponseField>
-
-<ResponseField name="body" type="string">
-
-The message text.
-
-</ResponseField>
-
-<ResponseExample title="message.created">
-
-```json
-{ "id": "msg_1", "body": "hey there", "user": "ada" }
-```
-
-</ResponseExample>
-
-</Message>
-
-<Message direction="send" name="message.send">
-
-Send a new message to the room.
-
-## Payload
-
-<ResponseField name="body" type="string" required>
-
-The message text to send.
-
-</ResponseField>
-
-</Message>
-
-</Channel>
-
-## Usage
-
-Wrap a channel in `<Channel>`, then mark each message with `<Message>` and
-document its payload with `ResponseField` and `ResponseExample`:
-
-```svelte
-<Channel address="/chat/{roomId}" protocol="wss" server="wss://api.example.com">
-	<Message direction="receive" name="message.created">
-		## Payload
-
-		<ResponseField name="body" type="string">The message text.</ResponseField>
-	</Message>
-
-	<Message direction="send" name="message.send">Send a message to the room.</Message>
-</Channel>
-```
-
-`receive` is server-to-client, `send` is client-to-server (the AsyncAPI
-`publish`/`subscribe` keywords work too).
-
-## Props
-
-### Channel
-
-| Prop          | Type     | Description                                    |
-| ------------- | -------- | ---------------------------------------------- |
-| `address`     | `string` | The channel or topic, e.g. `/chat/{roomId}`    |
-| `protocol`    | `string` | `ws`, `wss`, `kafka`, `mqtt`, … (default `ws`) |
-| `server`      | `string` | Base server URL, prepended to the address      |
-| `description` | `string` | Short summary of the channel                   |
-
-### Message
-
-| Prop        | Type     | Description                                    |
-| ----------- | -------- | ---------------------------------------------- |
-| `direction` | `string` | `send` or `receive` (or `publish`/`subscribe`) |
-| `name`      | `string` | The message name, e.g. `message.created`       |

package/src/content/demo/configuration/ai.md

@@ -1,40 +0,0 @@
----
-title: AI and LLMs
-description: Copy page, Markdown URLs, and llms.txt.
-icon: file-text
----
-
-# AI and LLMs
-
-Axerity makes your docs easy to feed to a language model.
-
-## Copy page
-
-Every page has a copy page button at the top right. The main button copies the
-page as clean Markdown, with the frontmatter and scripts stripped out. The
-dropdown has more options:
-
-- Copy page as Markdown.
-- View as Markdown, which opens the raw Markdown in a new tab.
-- Open in ChatGPT, with a prompt pointing at the page.
-- Open in Claude, with the same.
-
-## Markdown URLs
-
-Every page is also served as raw Markdown at a `.md` URL. Add `.md` to any page
-path:
-
-```
-/installation      ->  the rendered page
-/installation.md   ->  the raw Markdown
-```
-
-These are static files, generated at build time.
-
-## llms.txt
-
-Two files are generated for whole site ingestion, following the
-[llms.txt](https://llmstxt.org) convention:
-
-- `/llms.txt` is an index of every page with links to its Markdown.
-- `/llms-full.txt` is the full Markdown of every page in one file.

package/src/content/demo/configuration/cli.md

@@ -1,48 +0,0 @@
----
-title: CLI
-description: The axerity command.
-icon: code
----
-
-# CLI
-
-The `axerity` command scaffolds, runs, and builds your site. It carries the whole
-engine, so your project only holds content and config.
-
-## Commands
-
-```bash
-axerity init [dir]   # scaffold a new site (defaults to the current folder)
-axerity dev          # start the dev server
-axerity build        # build the static site
-axerity preview      # preview the production build
-```
-
-Run them with `pnpm dlx @axerity/cli <command>` (or `npx @axerity/cli <command>`),
-or add `@axerity/cli` as a dev dependency and call `axerity` through your scripts.
-
-## init
-
-`axerity init my-docs` creates a starter site: an `axerity.json`, a `docs/`
-folder with a couple of pages and a `meta.json`, and a `.gitignore`. Leave off
-the folder name to scaffold into the current directory.
-
-## dev
-
-`axerity dev` serves your site with live reload. Editing a Markdown file or
-`axerity.json` updates the browser immediately. Pass through any Vite flag, for
-example `axerity dev --port 4000`.
-
-## build
-
-`axerity build` produces a static site in `build/`. Every page is prerendered to
-HTML, and the search index, `llms.txt`, sitemap, RSS feed, and OpenGraph images
-are all written out, ready to host anywhere.
-
-## How it works
-
-The engine runs from its own install, not from your repo. When you run a command,
-Axerity reads your `docs/` and `axerity.json` and renders against them, then
-writes the result to `build/` in your project. Your content is the source of
-truth and nothing else in your folder is touched, so there is no workspace to
-gitignore beyond `build/`.

package/src/content/demo/configuration/deployment.md

@@ -1,105 +0,0 @@
----
-title: Deployment
-description: Build and host your docs.
-icon: rocket
----
-
-# Deployment
-
-`axerity build` writes a plain folder of static files to `build/`. Every page is
-prerendered to HTML, and the search index, `.md` URLs, `llms.txt`, sitemap, RSS
-feed, and OpenGraph images are all written out. Any static host can serve it, no
-server required.
-
-```bash
-axerity build   # -> build/
-```
-
-Most hosts write `.html` files (`installation.html`) but link to clean URLs
-(`/installation`), so the one thing to get right per host is **clean URL**
-handling. Each guide below covers it.
-
-## Vercel
-
-Add a `vercel.json` so Vercel serves the static output instead of looking for a
-SvelteKit server build:
-
-```json title="vercel.json"
-{
-	"framework": null,
-	"buildCommand": "axerity build",
-	"outputDirectory": "build",
-	"cleanUrls": true
-}
-```
-
-Push the repo and Vercel does the rest. If pages still 404, open Project →
-Settings and set the Framework Preset to **Other**.
-
-## Cloudflare Pages
-
-In the Pages project settings:
-
-- **Build command:** `npx @axerity/cli build`
-- **Build output directory:** `build`
-- **Framework preset:** None
-
-Cloudflare serves clean URLs automatically.
-
-## Netlify
-
-```toml title="netlify.toml"
-[build]
-  command = "npx @axerity/cli build"
-  publish = "build"
-```
-
-Netlify serves clean URLs (pretty URLs) by default.
-
-## GitHub Pages
-
-Build, then publish the `build/` folder (for example with a GitHub Action that
-runs `npx @axerity/cli build` and uploads `build/` as the Pages artifact).
-
-Project sites are served from `https://<user>.github.io/<repo>/`, a sub-path, so
-set the base in `axerity.json`:
-
-```json title="axerity.json"
-{
-	"basePath": "/<repo>"
-}
-```
-
-User and organization sites (served from the domain root) need no `basePath`.
-
-## Nginx
-
-Serve `build/` and fall back to the `.html` file for clean URLs:
-
-```nginx
-server {
-	listen 80;
-	server_name docs.example.com;
-	root /var/www/build;
-
-	location / {
-		try_files $uri $uri.html $uri/index.html /404.html;
-	}
-}
-```
-
-## Caddy
-
-```caddy
-docs.example.com {
-	root * /var/www/build
-	try_files {path} {path}.html {path}/index.html
-	file_server
-}
-```
-
-## Any other host
-
-Upload the contents of `build/` and point the host at it. Configure two things if
-you can: serve `<name>.html` for `/<name>` (clean URLs), and use `404.html` as
-the not-found page.

package/src/content/demo/configuration/index.md

@@ -1,92 +0,0 @@
----
-title: The config file
-description: Everything you set in axerity.json.
-icon: sliders
----
-
-# The config file
-
-The whole site is configured from one file at the project root: `axerity.json`.
-You never edit code to change the site. Drop in Markdown, set up your
-`meta.json` files for ordering, and edit `axerity.json` for everything global.
-
-## Editor autocomplete
-
-The repo ships a JSON schema. Point your config at it on the first line and your
-editor gives you autocomplete and validation for every field:
-
-```json title="axerity.json"
-{
-	"$schema": "./axerity.schema.json"
-}
-```
-
-## A full example
-
-```json title="axerity.json"
-{
-	"$schema": "./axerity.schema.json",
-	"name": "Axerity",
-	"description": "A documentation site generator built with Svelte.",
-	"url": "https://axerity.com",
-	"github": "https://github.com/your/repo",
-	"editLink": "https://github.com/your/repo/edit/main/src/content/docs",
-	"theme": "stripe",
-	"layout": "boxed",
-	"sidebar": { "variant": "floating" },
-	"logo": { "light": "/logo-light.svg", "dark": "/logo-dark.svg" },
-	"og": { "enabled": true },
-	"banner": { "text": "v1.0 is out", "href": "/docs", "id": "v1", "dismissible": true },
-	"versions": [{ "label": "v1.0", "href": "/docs" }],
-	"dropdowns": [
-		{
-			"label": "Guides",
-			"icon": "book-open",
-			"href": "/docs",
-			"match": "/docs",
-			"tabs": [{ "title": "Documentation", "href": "/docs", "match": "/docs" }]
-		}
-	],
-	"sidebarLinks": [{ "title": "Support", "href": "https://example.com/support" }],
-	"social": [{ "icon": "rss", "href": "/rss.xml" }],
-	"footer": { "note": "Built with Axerity", "links": [{ "title": "Status", "href": "/status" }] },
-	"analytics": { "plausible": "axerity.com" },
-	"topNav": [{ "title": "Docs", "href": "/docs" }]
-}
-```
-
-## Fields
-
-| Field          | Type                     | What it does                                                                                |
-| -------------- | ------------------------ | ------------------------------------------------------------------------------------------- |
-| `name`         | string                   | Site name, used in the page title and navbar                                                |
-| `description`  | string                   | Site description, used for SEO and `llms.txt`                                               |
-| `url`          | string                   | Canonical site URL; enables absolute links in sitemap, RSS, and OpenGraph                   |
-| `github`       | string                   | Repo URL, shown as the GitHub icon in the navbar and footer                                 |
-| `editLink`     | string                   | Base URL for the "Edit this page" link; the source path is appended                         |
-| `theme`        | string                   | A built-in [theme](/theming/themes) preset                                                  |
-| `brand`        | object                   | Custom `{ accent, radius }` that override the theme. See [Colors](/theming/colors)          |
-| `layout`       | string                   | `flat` (default) or `boxed`. See [Layouts](/configuration/layouts)                          |
-| `basePath`     | string                   | Serve the whole site under a sub-path like `/docs`. Empty (default) is the root             |
-| `sidebar`      | object                   | Sidebar appearance: `{ "variant": "flush" \| "card" \| "floating" }`                        |
-| `logo`         | object                   | Navbar logo `{ light, dark, alt, href }`. Local SVGs are inlined                            |
-| `og`           | object                   | Per-page OpenGraph image generation `{ enabled, background, foreground, … }`                |
-| `ogImage`      | string                   | Static OG image path, used when `og.enabled` is off                                         |
-| `banner`       | object                   | Announcement bar `{ text, href, id, dismissible }`                                          |
-| `analytics`    | object                   | `{ plausible, googleAnalytics }` scripts injected on every page                             |
-| `topNav`       | array                    | Fallback top nav links when no dropdowns are set                                            |
-| `versions`     | array                    | Versions shown in the navbar version switcher                                               |
-| `dropdowns`    | array                    | Areas that swap the whole sidebar. See [Navigation](/configuration/navigation)              |
-| `openapi`      | string, object, or array | Generate an API reference from an OpenAPI spec. See [API reference](/configuration/openapi) |
-| `sidebarLinks` | array                    | Links pinned to the bottom of the sidebar                                                   |
-| `social`       | array                    | Social links shown in the footer `{ icon, href, label }`                                    |
-| `footer`       | object                   | Footer `{ note, links }`                                                                    |
-
-Every field except `name` and `topNav` is optional. Leave a field out and the
-related UI does not render.
-
-## Icons
-
-Anywhere a config field takes an `icon`, use a [Lucide](https://lucide.dev) icon
-name in kebab case, such as `book-open`, `credit-card`, or `git-branch`. Any
-Lucide icon works, so you never register icons by hand.

package/src/content/demo/configuration/layouts.md

@@ -1,51 +0,0 @@
----
-title: Layouts
-description: Page width and the API layout.
-icon: layout-grid
----
-
-# Layouts
-
-## Flat and boxed
-
-The whole shell has two modes, set with `layout` in `axerity.json`:
-
-```json title="axerity.json"
-{
-	"layout": "flat"
-}
-```
-
-- `flat` (default) is full width. The sidebar sits at the left edge.
-- `boxed` centers the shell in a max-width container on wide screens.
-
-## The doc layout
-
-Normal pages use the three column layout: sidebar on the left, content in the
-middle, and a table of contents on the right. The table of contents tracks your
-scroll position. It hides on narrow screens, and the sidebar becomes a drawer.
-
-## The API layout
-
-Set `layout: api` in a page's frontmatter to switch to the API layout. It is
-wider, drops the table of contents, and gives you a two column layout with the
-content on the left and sticky request and response examples on the right.
-
-```md
----
-title: Create a user
-layout: api
----
-```
-
-See the [API reference components](/api/pet/pet-object) for what you can
-put on these pages.
-
-## On every page
-
-Both layouts include a few things automatically:
-
-- A breadcrumb trail above the title.
-- A copy page button. See [AI and LLMs](/configuration/ai).
-- Previous and next links at the bottom.
-- A footer.

package/src/content/demo/configuration/meta.json

@@ -1,5 +0,0 @@
-{
-	"title": "Configuration",
-	"icon": "sliders",
-	"pages": ["index", "navigation", "layouts", "search", "openapi", "ai", "cli", "deployment"]
-}