Reference
/api/customization exposes reusable editor primitive metadata, plugin extension points, block templates, and shortcut scopes/ for Mermaid diagrams, math blocks, Excalidraw drawings, data tables, decision trees, headings, and more; includes user snippets via /snippetOPENAI_API_KEY$...$ and block $$...$$ math expressions/pull quote or Mod+Shift+Q-- → em dash, ... → ellipsis, and straight quotes to curly quotes as you type<details> blocks via /accordion/two-column layout/youtube; auto-converts to a responsive 16:9 iframe/twitter; renders as a styled card with the post link/timeline/github gist<figcaption> below the image[[Article Name]] syntax with autocomplete; broken links shown in redWiki is the workspace boundary for bootstrap profiles, visibility, default roles, invitations, settings, marketplace selections, and scoped article/search/category/tag APIs/categories/[slug]/concept-map/api/tags/[id]/synonyms/api/search/contract publishes typed result shapes for articles, categories, tags, discussions, revisions, and marketplace items plus privacy, retention, and webhook planning metadataCmd+K / Ctrl+K opens grouped destinations across navigation, discovery, personal, reference, and admin surfaces/api/discovery reports duplicate pages, unresolved questions, canon conflicts, glossary gaps, orphan topics, topic clusters, continue-reading modules, admin actions, and dashboard widgets/compare?a=slug1&b=slug2@username for the logged-in user/share/[token]) so non-admins can preview a draft without publishingA personalizable homepage at /dashboard with a draggable widget grid.
/present/[slug]; each H2/H3 is a slide, and long content scrolls within the slide stage rather than covering controls@mention triggers notifications, and admins can moderate reported, hidden, removed, or reviewer-only threadsAI features degrade gracefully when API keys are absent.
/api/assistant-packs, /admin/assistants, and docs/assistant-packs.md expose opt-in drafting, summarization, search, claim extraction, taxonomy, alt-text, import cleanup, and review packs with per-space availability, prompt/context previews, usage/cost metadata, permissions, safety, and fallback metadata/api/assistant-packs/governance and docs/assistant-governance.md publish privacy warnings, human-review requirements, citation prompts, confidence metadata, AI audit events, private/sensitive opt-outs, and the optional/non-blocking release gateStandalone Excalidraw canvases at /whiteboards — separate from article-embedded drawings.
Capture content from the web directly into the wiki without switching context.
Import
.md, .txt, .html, or .json at /import.zip; front matter and [[wikilinks]] resolved automaticallyExport
.md), ePub 3, Word (.docx) — per article via the Export ▾ menu.zip of Markdown files, one per article, organised in category subfolders with YAML front-matter/api/v1/ with X-API-Key auth, frozen contract metadata at /api/v1/contract, OpenAPI JSON at /api/v1/openapi.json, standard v1 headers, fixture responses, and a pre-v5 migration guide. See API Documentation./api/v1/sdk and docs/sdk-types.md publish REST payload, webhook event, customization, marketplace pack, plugin manifest, export bundle, API key scope, generated client example, and sample script metadata./api/admin/operations?bundle=1 expose admin-only service health, queue health, slow pages, failed webhooks/imports/exports/plugins, alerts, acknowledgements, and redacted support bundles./api/admin/maintenance/report expose safe-upgrade checks, backup reminders, background task pausing, cleanup queues, and runbook metadata./api/admin/observability, and /api/observability/metrics expose structured events, metric ingestion, privacy controls, and external collector guidance./api/admin/performance expose route p95, interaction, and bundle budgets, large-wiki fixtures, slow samples, and slow-query diagnostics./api/admin/cache expose cache invalidation rules, manual invalidation, stale warnings, Redis status, and deployment recipes./api/offline/contract, /sw.js, and /offline.html define install prompts, offline reading caches, stale indicators, retry queues, mobile QA, draft warnings, and privacy limits./api/mobile-polish and docs/mobile-polish.md define responsive QA, 44px touch targets, safe-area checks, overflow/clipping guardrails, dialog bounds, and mobile help screenshot slots./api/desktop-research and docs/desktop-app-research.md compare Electron, Tauri, browser PWA, and Docker Desktop options without committing desktop packaging to v5 scope./api/accessibility and docs/accessibility.md define keyboard/focus/dialog/dropdown/control audits, widget summaries, contrast/motion checks, and v5 accessibility blockers./api/security/review, docs/security-review.md, and middleware headers define reviewed surfaces, abuse-case gates, supply-chain checks, and the pre-v5 threat-model draft./api/privacy/controls and docs/privacy-controls.md define deployment-mode controls, retention settings, user export/deletion planning, and AI/external integration warnings./api/marketplace/security and docs/secure-marketplace-plugins.md define unsafe pack rejection, blocked permissions/hooks, dangerous plugin capability warnings, provenance checks, and local-only installation guidance./api/marketplace/beta and docs/marketplace-beta.md publish beta metrics, featured/recent/recommended packs, collections, compatibility badges, search facets, install-intent steps, and limitations./api/marketplace/lifecycle and docs/marketplace-lifecycle.md define pack states, transitions, inventory, health checks, preview media validation, update metadata, compatibility warnings, and rollback guidance./api/marketplace/authoring and docs/marketplace-authoring.md define pack author dashboard metadata, README generator/checklist output, Arkivel compatibility matrix rows, author quality expectations, and submission templates./api/marketplace/templates and docs/template-marketplace.md define template-pack listings, included schema, category and article previews, compatibility notes, diff/merge contracts, and export-from-space fixture output./api/sync-manifests and docs/sync-manifests.md define source/target manifests, checksums, dry-run reports, signed snapshot plans, staging promotion checks, and the network-federation release gate./api/external-references and docs/external-references.md define imported/mirrored provenance, diagnostics, and public index planning that excludes private content./api/archive-mirrors and docs/archive-mirror-workflows.md define read-only archive snapshots, private mirror setup, selected-space transfers, repeated-sync conflict notes, and the pre-v5 federation decision checkpoint./api/migration-readiness and docs/migration-readiness.md define blocking migration dry runs, backup prompts, schema compatibility reports, restore validation, representative v4 upgrade paths, and failure recovery guidance./api/backup-restore and docs/backup-restore.md define admin backup wizard sections, restore rehearsal validation, scheduled backup planning, external storage notes, and disaster-recovery drill guidance./api/upgrade-assistant and docs/v5-upgrade-planning.md define v5 readiness checks, pre-upgrade diagnostics, post-upgrade smoke checks, compatibility warnings, and release-note/migration doc links./api/test-quality and docs/test-quality-gates.md define expanded test surfaces, stable QA fixtures, CI matrix planning, warning policy, and release-manager dashboard planning./api/e2e-smoke-suite, e2e/smoke-suite.spec.ts, and docs/e2e-smoke-suite.md define product smoke flows, responsive routes, fixture seeding, and failure screenshots/traces./api/release-gates, scripts/verify-docs-sync.mjs, and docs/release-gate-automation.md define release candidate gates, docs sync verification, checklist metadata, known issues, and blocker labels./api/documentation-onboarding, docs/index.md, and docs/maintainer-guide.md define maintainer docs, setup paths, troubleshooting, docs IA, and practical link-test coverage./api/in-app-onboarding, docs/in-app-onboarding.md, and examples/onboarding/demo-content-pack.json define first-run setup, guided admin topics, contextual help panels, demo content, and screenshot checkpoints./api/example-site-recipes, docs/example-site-recipes.md, and examples/recipes/site-recipes.json define setup recipes, env snippets, screenshot targets, pack recommendations, migration stories, and v5 readiness checks./api/release-freeze, docs/feature-freeze.md, and docs/known-issues.md define freeze policy, rehearsal matrix, blocker labels, v5 gate ownership, and release-note draft sections./api/release-candidate-one, docs/release-candidate-one.md, and docs/rc-feedback-template.md define RC1 gates, deployment validation, starter/pack/import/export validation, review checklists, and feedback template./api/final-release-gates and docs/final-release-gates.md define RC fixes, final beta freeze contracts, gate evidence, compatibility targets, correction windows, and stable v5 release gates./api/graphql powered by graphql-yoga; includes GraphiQL playground. Queries for articles, categories, tags, revisions, search, and stats./api/customization exposes grouped brand, style preset, color theme, layout, feature flag, limit, map, reusable component, editor control, collaboration UX, public API v1, SDK type, webhook reliability, operations dashboard, maintenance tooling, observability, performance budgets, cache strategy, offline/PWA, mobile polish, desktop research, accessibility finish, migration readiness, backup/restore, upgrade assistant, test quality gates, e2e smoke suite, release gate automation, documentation onboarding, in-app onboarding, example site recipes, feature freeze, release candidate one, final release gates, security review, privacy controls, marketplace security, marketplace beta, marketplace lifecycle, marketplace authoring, template marketplace, sync manifest, external reference, archive mirror, component slot, persisted space customization, marketplace registry/import-preview, plugin manifest schema/examples/compatibility matrix, plugin, theme-pack, template-pack, migration guidance, and theme-hook metadata for self-hosters, plugins, forks, and deployment dashboards.plugin.json manifests only when ARKIVEL_ENABLE_TRUSTED_PLUGINS=true and an absolute ARKIVEL_TRUSTED_PLUGIN_DIR are configured, then shows permissions, routes, widgets, hooks, compatibility, and load errors before enablement.examples/plugins/starter-plugin/, docs/plugin-authoring.md, examples/plugins/marketplace-listing-template.json, and npm run plugin:validate give authors a manifest, route, widget, setting, hook, job, smoke-test checklist, compatibility notes, and validation workflow.docs/portable-bundles.md defines the pre-v5 full-site bundle manifest, checksums, source metadata, export scope, sessions/API-key/analytics exclusions, privacy filters, and import dry-run report shape for conflicts, missing assets, unsupported schemas, duplicate slugs, and permission gaps./api/export/history?download=1 downloads reports with file counts, byte counts, omitted private data, warnings, status, and scope metadata./api/import/rehearsal exposes dry-run conflict categories, recommended actions, blocked changes, rollback plans, and fixture profiles for small wiki, large archive, docs portal, and worldbuilding atlas imports before any write-capable flow.docs/workspaces.md documents bootstrap profiles, invitation APIs, scoped API parameters, marketplace selections, and single-workspace migration.docs/role-templates.md documents role templates, API-key behavior, invitation expiration/resend/revoke actions, audit events, and admin recovery guidance.docs/private-team-knowledge-base.md documents private workspace setup, collaboration routing, user preferences, and public-surface visibility rules./api/admin/editorial-governance/summary reports release blockers, editorial risk, claim queues, verification renewals, and owner gaps./api/categories/:id/customization and /api/articles/:id/customization resolve global, parent-space, space, and article overrides for style, color theme, layout, component pack, template pack, navigation, and metadata schema while hiding private draft config from public reads./api/space-templates exposes preview-safe personal wiki, product docs, team handbook, worldbuilding bible, research notebook, reading archive, project knowledge base, and public documentation templates, with preview pages, JSON validation, one-click local import previews, category trees, starter articles, sample metadata, tags, infobox fields, navigation, dashboards, layouts, and recommended packs./api/space-workflows and docs/domain-workflows.md publish workflow controls, steps, starter template links, and release gates for docs portals, team handbooks, worldbuilding, research, and personal wiki products./api/categories/:id/governance persists category owner, reviewer, default visibility, review cadence, stale-page threshold, and health-signal preferences. Article pages show inherited governance badges, and the admin dashboard summarizes space health widgets for stale pages, unreviewed claims, orphaned content, and broken links.html[data-layout="..."] hooks.examples/marketplace/component-pack, and plan previews with typed article, category, dashboard, marketplace, and editor fixtures.NEXT_PUBLIC_ARKIVEL_STYLE switches between the default classic-wiki skin and the alternate atlas-modern skin without changing route code.NEXT_PUBLIC_ARKIVEL_COLOR_THEME switches between standard, forest, and ember palettes independently from the selected style preset.NEXT_PUBLIC_ARKIVEL_LAYOUT publishes layout intent such as classic-wiki, docs-portal, team-knowledge-base, worldbuilding-atlas, or research-notebook for preview and future shell variants..env, .env.local, Vercel, or Docker Compose output.docs/marketplace-contributions.md, examples/marketplace/, and GitHub issue templates document preview-safe pack submissions, naming/versioning rules, sample manifests, review checklists, screenshots, and validation expectations./feed.xml and /feed/atom/embed/[token]/wiki <query> slash command to search from Slack/wiki slash command in DiscordOptional feature. Enable with NEXT_PUBLIC_MAP_ENABLED=true.
/users/[username], settings at /settings/api/offline/contract/api/mobile-polish/api/accessibility/api/security/review/api/privacy/controls/api/marketplace/security/api/marketplace/beta/api/marketplace/lifecycle/api/marketplace/authoring/api/marketplace/templates/api/sync-manifests/api/external-references/api/archive-mirrorsvX.Y.Z: imperative summarydocs/moderation.md documents discussion reports, reviewer-only notes, suggestion queue actions, public contribution spam scoring, and rate-limit planning/articles/[slug]/blame; each paragraph colour-coded by the revision that introduced it with editor name, date, and edit summary~X min left counter in the article byline that decreases as you scroll; disappears on completiondocs/editor-troubleshooting.md covers draft recovery, snapshot restore/compare/discard, offline warnings, autosave repair, paste/embed handling, diagnostics, and large-document fixturesLocalDate component renders dates in the user's browser timezone/tabs slash command; interactive tab panels in articles; stacked for editing/gallery slash command; responsive auto-fill image grid with captions and hover zoom/button slash command inserts a styled call-to-action button with configurable label, URL, and style (primary / secondary / outline)/divider slash command inserts a horizontal rule with an optional centered text label/present/[slug] is a cinematic slideshow with reserved top/bottom chrome, a scrollable slide stage, animated transitions, slide overview, fullscreen, and dot navigation/articles/[slug]/analytics shows 30-day view chart, reads, reactions, and revision count (admin only)NEXT_PUBLIC_* environment variables