@axerity/cli 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Axerity Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# Axerity

package/axerity.default.json

@@ -0,0 +1,135 @@
+{
+	"$schema": "./axerity.schema.json",
+	"name": "Axerity",
+	"description": "A documentation site generator built with Svelte.",
+	"url": "https://axerity.com",
+	"github": "https://github.com/axerity",
+	"editLink": "https://github.com/axerity/axerity/edit/main/src/content/docs",
+	"og": {
+		"enabled": true,
+		"background": "#0a0a0a",
+		"foreground": "#fafafa",
+		"muted": "#a1a1a1",
+		"accent": "#fafafa"
+	},
+	"logo": {
+		"light": "/favicon-light.svg",
+		"dark": "/favicon-dark.svg",
+		"alt": "Axerity",
+		"href": "/"
+	},
+	"layout": "flat",
+	"theme": "neutral",
+	"sidebar": {
+		"variant": "card"
+	},
+	"versions": [
+		{
+			"label": "v1.0-preview",
+			"href": "/"
+		}
+	],
+	"dropdowns": [
+		{
+			"label": "Guides",
+			"icon": "book-open",
+			"href": "/",
+			"match": "/",
+			"tabs": [
+				{
+					"title": "Documentation",
+					"href": "/",
+					"match": "/",
+					"icon": "book-open"
+				},
+				{
+					"title": "Components",
+					"href": "/components/callout",
+					"match": "/components",
+					"icon": "blocks"
+				}
+			]
+		},
+		{
+			"label": "API Reference",
+			"icon": "code",
+			"href": "/api/pet/pet-object",
+			"match": "/api",
+			"tabs": [
+				{
+					"title": "Pet",
+					"href": "/api/pet/pet-object",
+					"match": "/api/pet",
+					"icon": "paw-print"
+				},
+				{
+					"title": "Store",
+					"href": "/api/store/order-object",
+					"match": "/api/store",
+					"icon": "shopping-cart"
+				},
+				{
+					"title": "User",
+					"href": "/api/user/user-object",
+					"match": "/api/user",
+					"icon": "user"
+				}
+			]
+		},
+		{
+			"label": "Petstore API",
+			"icon": "paw-print",
+			"href": "/petstore-api/pet/addpet",
+			"match": "/petstore-api",
+			"tabs": [
+				{
+					"title": "Pet",
+					"href": "/petstore-api/pet/addpet",
+					"match": "/petstore-api/pet",
+					"icon": "paw-print"
+				},
+				{
+					"title": "Store",
+					"href": "/petstore-api/store/getinventory",
+					"match": "/petstore-api/store",
+					"icon": "shopping-cart"
+				},
+				{
+					"title": "User",
+					"href": "/petstore-api/user/createuser",
+					"match": "/petstore-api/user",
+					"icon": "user"
+				},
+				{
+					"title": "Schemas",
+					"href": "/petstore-api/schemas/order",
+					"match": "/petstore-api/schemas",
+					"icon": "box"
+				}
+			]
+		}
+	],
+	"sidebarLinks": [
+		{
+			"title": "Issues",
+			"href": "https://github.com/axerity/axerity/issues"
+		}
+	],
+	"openapi": [
+		{
+			"spec": "petstore-openapi.json",
+			"output": "petstore-api",
+			"title": "Petstore API"
+		}
+	],
+	"topNav": [
+		{
+			"title": "Docs",
+			"href": "/"
+		},
+		{
+			"title": "Components",
+			"href": "/components/callout"
+		}
+	]
+}

package/axerity.schema.json

@@ -0,0 +1,268 @@
+{
+	"$schema": "http://json-schema.org/draft-07/schema#",
+	"$id": "https://axerity.com/axerity.schema.json",
+	"title": "Axerity configuration",
+	"description": "Site-wide configuration for an Axerity documentation site.",
+	"type": "object",
+	"additionalProperties": false,
+	"required": ["name", "topNav"],
+	"properties": {
+		"$schema": {
+			"type": "string",
+			"description": "Path or URL to this JSON schema, for editor autocomplete."
+		},
+		"name": {
+			"type": "string",
+			"description": "Site name, used in the page title and the navbar."
+		},
+		"tagline": {
+			"type": "string",
+			"description": "Short tagline for the site."
+		},
+		"description": {
+			"type": "string",
+			"description": "Site description, used for SEO meta tags and llms.txt."
+		},
+		"url": {
+			"type": "string",
+			"format": "uri",
+			"description": "Canonical site URL. Enables absolute links in sitemap, RSS, and OpenGraph."
+		},
+		"ogImage": {
+			"type": "string",
+			"description": "Path to a static OpenGraph image, used when per-page generation is off."
+		},
+		"og": {
+			"type": "object",
+			"additionalProperties": false,
+			"description": "Per-page OpenGraph image generation.",
+			"properties": {
+				"enabled": {
+					"type": "boolean",
+					"description": "Generate a unique OG image per page at build time."
+				},
+				"background": { "type": "string", "description": "Card background color (any CSS color)." },
+				"foreground": { "type": "string", "description": "Title color." },
+				"muted": { "type": "string", "description": "Description and footer color." },
+				"accent": { "type": "string", "description": "Accent color for the mark fallback." },
+				"logo": {
+					"type": "string",
+					"description": "Path to the logo SVG shown in the card. Defaults to the site logo."
+				}
+			}
+		},
+		"logo": {
+			"type": "object",
+			"additionalProperties": false,
+			"description": "Navbar logo. Local SVGs are inlined; other formats render as an image.",
+			"properties": {
+				"light": { "type": "string", "description": "Logo shown in light mode." },
+				"dark": { "type": "string", "description": "Logo shown in dark mode." },
+				"alt": { "type": "string", "description": "Alt text / aria-label." },
+				"href": { "type": "string", "description": "Where the logo links to (default /)." }
+			}
+		},
+		"topNav": {
+			"type": "array",
+			"description": "Fallback top-nav links shown when no dropdowns are configured.",
+			"items": { "$ref": "#/definitions/navLink" }
+		},
+		"versions": {
+			"type": "array",
+			"description": "Versions shown in the navbar version switcher.",
+			"items": {
+				"type": "object",
+				"additionalProperties": false,
+				"required": ["label", "href"],
+				"properties": {
+					"label": { "type": "string" },
+					"href": { "type": "string" }
+				}
+			}
+		},
+		"dropdowns": {
+			"type": "array",
+			"description": "Areas that swap the whole sidebar, each with its own tabs.",
+			"items": {
+				"type": "object",
+				"additionalProperties": false,
+				"required": ["label", "href"],
+				"properties": {
+					"label": { "type": "string" },
+					"icon": { "type": "string" },
+					"href": { "type": "string" },
+					"match": { "type": "string" },
+					"tabs": { "type": "array", "items": { "$ref": "#/definitions/navLink" } }
+				}
+			}
+		},
+		"sidebarLinks": {
+			"type": "array",
+			"description": "Links pinned to the bottom of the sidebar.",
+			"items": {
+				"type": "object",
+				"additionalProperties": false,
+				"required": ["title", "href"],
+				"properties": {
+					"title": { "type": "string" },
+					"href": { "type": "string" }
+				}
+			}
+		},
+		"social": {
+			"type": "array",
+			"description": "Social links shown in the footer.",
+			"items": {
+				"type": "object",
+				"additionalProperties": false,
+				"required": ["icon", "href"],
+				"properties": {
+					"icon": { "type": "string", "description": "Lucide icon name." },
+					"href": { "type": "string" },
+					"label": { "type": "string" }
+				}
+			}
+		},
+		"footer": {
+			"type": "object",
+			"additionalProperties": false,
+			"description": "Footer content.",
+			"properties": {
+				"note": { "type": "string", "description": "Text shown on the right of the footer." },
+				"links": {
+					"type": "array",
+					"items": {
+						"type": "object",
+						"additionalProperties": false,
+						"required": ["title", "href"],
+						"properties": {
+							"title": { "type": "string" },
+							"href": { "type": "string" }
+						}
+					}
+				}
+			}
+		},
+		"banner": {
+			"type": "object",
+			"additionalProperties": false,
+			"description": "Announcement bar above the navbar.",
+			"required": ["text"],
+			"properties": {
+				"text": { "type": "string" },
+				"href": { "type": "string" },
+				"id": { "type": "string", "description": "Stable id used to remember dismissal." },
+				"dismissible": { "type": "boolean" }
+			}
+		},
+		"analytics": {
+			"type": "object",
+			"additionalProperties": false,
+			"description": "Analytics scripts injected on every page.",
+			"properties": {
+				"plausible": { "type": "string", "description": "Plausible data-domain." },
+				"googleAnalytics": { "type": "string", "description": "Google Analytics measurement id." }
+			}
+		},
+		"brand": {
+			"type": "object",
+			"additionalProperties": false,
+			"description": "Override the accent and corners on top of the theme preset.",
+			"properties": {
+				"accent": { "type": "string", "description": "Accent color (any CSS color)." },
+				"accentDark": {
+					"type": "string",
+					"description": "Accent color in dark mode (defaults to accent)."
+				},
+				"accentContrast": {
+					"type": "string",
+					"description": "Text color on the accent (default white)."
+				},
+				"radius": { "type": "string", "description": "Base corner radius, e.g. \"0.5rem\"." }
+			}
+		},
+		"openapi": {
+			"description": "Generate API references from OpenAPI 3 specs (local path or URL, JSON or YAML). Use an array to group several specs.",
+			"oneOf": [
+				{ "type": "string", "description": "Local path or http(s) URL to an OpenAPI 3 spec." },
+				{ "$ref": "#/definitions/apiSource" },
+				{ "type": "array", "items": { "$ref": "#/definitions/apiSource" } }
+			]
+		},
+		"editLink": {
+			"type": "string",
+			"description": "Base URL for the 'Edit this page' link; the source path is appended."
+		},
+		"github": {
+			"type": "string",
+			"description": "Repository URL, shown as the GitHub icon in the navbar and footer."
+		},
+		"layout": {
+			"type": "string",
+			"enum": ["flat", "boxed"],
+			"description": "Page shape: flat (full-bleed) or boxed (centered max-width)."
+		},
+		"theme": {
+			"type": "string",
+			"enum": [
+				"neutral",
+				"stripe",
+				"vercel",
+				"linear",
+				"supabase",
+				"github",
+				"tailwind",
+				"mintlify",
+				"anthropic"
+			],
+			"description": "Built-in color theme preset."
+		},
+		"sidebar": {
+			"type": "object",
+			"additionalProperties": false,
+			"description": "Sidebar appearance.",
+			"properties": {
+				"variant": {
+					"type": "string",
+					"enum": ["flush", "card", "floating"],
+					"description": "flush (default), card (inset panel), or floating (detached card)."
+				}
+			}
+		},
+		"basePath": {
+			"type": "string",
+			"description": "Serve the whole site under a sub-path, e.g. \"/docs\". Empty serves at the root.",
+			"pattern": "^(/[^/]+)*$"
+		}
+	},
+	"definitions": {
+		"apiSource": {
+			"type": "object",
+			"additionalProperties": false,
+			"required": ["spec"],
+			"properties": {
+				"spec": {
+					"type": "string",
+					"description": "Local path or http(s) URL to an OpenAPI 3 spec (JSON or YAML)."
+				},
+				"output": {
+					"type": "string",
+					"description": "Content folder for this group (default api-reference)."
+				},
+				"title": { "type": "string", "description": "Section title (defaults to info.title)." }
+			}
+		},
+		"navLink": {
+			"type": "object",
+			"additionalProperties": false,
+			"required": ["title", "href"],
+			"properties": {
+				"title": { "type": "string" },
+				"href": { "type": "string" },
+				"icon": { "type": "string", "description": "Lucide icon name." },
+				"match": { "type": "string", "description": "Path prefix that marks this link active." },
+				"external": { "type": "boolean", "description": "Open in a new tab." }
+			}
+		}
+	}
+}