Reference
To create a new article, click Create new article in the sidebar or navigate to /articles/new.
Each article has:
The rich text editor opens as a calm writing surface with advanced tools tucked into feature trays:
Slash commands: Type / anywhere in the editor to open the command palette. Commands include reusable callout, metadata table, timeline, infobox, decision log, research note, worldbuilding entry templates, Mermaid diagram, Math block, Excalidraw drawing, Data table, Decision tree, heading/list types, accordion/FAQ block, two-column layout, YouTube/Vimeo video embed, Twitter/X post embed, GitHub Gist embed, and your saved snippets via /snippet.
Feature trays: Click Insert, Review, or Outline when you need advanced tools. The editor keeps those panels closed by default so the writing canvas stays clear.
Selection actions: Selecting text opens inline actions for AI rewrite, AI expand, wiki links, URL links, and footnotes.
Markdown mode: Click the Markdown button to switch to raw markdown editing. Click Write to switch back.
Templates: When creating a new article, choose from predefined templates (Person, Place, Event, Thing, Group) that provide a starting structure with an infobox and sections.
Outline builder: Open the Outline tray to generate a structured list of section headings from the article title. Choose Encyclopedic, Tutorial, or Reference style. Click Insert into article to add the headings as editable H2/H3 nodes.
AI alt-text: When you upload an image, the caption prompt is pre-filled with a suggested description based on the filename (AI-enhanced when AI_API_KEY is configured).
Grammar & style checker: Open the Review tray and expand “Grammar & style” to check your text for issues. Click Check now to analyse; each issue shows a severity (error / warning / style) with an Apply button to fix it inline.
Beyond standard text, the editor supports specialized content blocks inserted via slash commands:
graph TD; A-->B syntax; renders as a flowchart, sequence diagram, Gantt chart, etc. on the article page$...$ and block math with $$...$$Voice dictation: Click the microphone button in the toolbar to speak — your words are inserted at the cursor using the browser's speech recognition.
Click Present in the article action bar to open the article as a slideshow. Each H2 / H3 heading becomes a new slide. Use arrow keys or click to advance. Press Esc to exit. Long slides scroll inside the slide stage so the title, progress, overview, and navigation controls stay reachable.
The compact rail below the article header keeps Navigate, Collect, and Share actions visible. Read and Tools open as disclosure menus so dense reading controls stay available without taking over the page.
Typing syntax
[[Article Name]] — auto-converts to a wiki link[[Article Name|Display Text]] — link with custom display textLink suggester
Type [[ to open the autocomplete dropdown. Use arrow keys to navigate, Enter to select, Escape to dismiss.
Link status
Links to existing articles appear in blue. Links to missing articles appear in red— a cue to create that article.
Keyboard shortcut
Press Ctrl+Shift+L (Cmd on Mac) to insert a wiki link.
/api/customization, including primitive names, plugin extension points, block templates, and shortcut scopes/api/customization, including connection states, conflict/reconnect copy, notification routing, mobile QA, and accessibility checkpoints/api/search?q=...&explain=1 for per-result score explanations/api/search/contract for stable typed result shapes and privacy metadataOPENAI_API_KEY to blend AI-ranked results based on meaning, not just keywordsAI features are gated on environment variables and degrade gracefully when 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 notes, and fallback metadata for local/offline-friendly deployments./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 gate.OPENAI_API_KEY./api/discovery reports duplicate pages, unresolved questions, canon conflicts, glossary gaps, orphan topics, topic clusters, and continue-reading opportunities./compare?a=slug1&b=slug2.@username (requires login).POST /api/articles/[id]/share-token) so anyone with the link can preview a draft at /share/[token] without needing to log in.POST /api/articles/[id]/snapshots.object-position when the image is displayed.@username to notify a contributor.Categories are hierarchical groups shown in the sidebar. Each article belongs to one category. Browse all at Categories.
Tags are hierarchical labels; an article can have multiple tags. Browse all at Tags, which shows a size-scaled tag cloud.
Import
.md, .txt, .html, or .json at Import.zip at /import/obsidian. Front matter and [[wikilinks]] are resolved automatically.Export
.md file.zip of Markdown files from the Export page — one .md per article with YAML front-matter, organised in category subfoldersAll export formats are in the Export ▾ dropdown on every article page.
Confluence import
Upload a Confluence HTML export file or paste the HTML directly at /admin/import. The title is extracted from the page heading and Confluence macros are stripped. The result is saved as a draft article.
Save content from the web directly into the wiki without leaving your browser.
Browser extension
Install the Manifest V3 browser extension (Chrome, Edge, Brave) from /clipper-extension. Click the extension popup on any page: the title and selected text are pre-filled; choose a category and click Save to Wiki. The article is created as a draft and the popup offers “Open editor” to refine it.
Bookmarklet
Go to /bookmarklet and drag the button to your bookmarks bar (or copy the code). Click the bookmarklet on any page to clip the URL, title, and selected text as a draft article. Selected text is wrapped in a blockquote with a source link; full-page HTML has nav/headers/scripts stripped.
Create standalone Excalidraw canvases at /whiteboards. These are separate from the Excalidraw blocks you can embed inside articles.
Your personalized homepage at /dashboard shows a grid of widgets you can rearrange and toggle.
docs/editor-troubleshooting.md covers draft recovery, snapshot restore/compare/discard, offline warnings, autosave repair, paste/embed handling, diagnostics, and large-document fixtures.Arkivel - Page Name, with the visible page heading used as the fallback when a route does not define metadata/tabs slash command inserts an interactive two-tab block; panels are editable inline/gallery slash command inserts a responsive image grid with captions/button slash command inserts a 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]; cinematic full-screen slideshow with a scrollable slide stage, keyboard navigation, slide overview grid (G), fullscreen (F), and responsive controls that avoid overlap/articles/[slug]/analytics; 30-day view chart + summary stats/api/random?category=slugAchievements are awarded automatically based on contribution activity:
Unlock notifications appear as a toast after saving.
/wiki <query> slash command to search articles from Slack. Requires SLACK_SIGNING_SECRET./wiki slash command in Discord. Requires DISCORD_PUBLIC_KEY./embed/[token] is iframe-safe with no navigation.Optional feature, disabled by default. Enable with NEXT_PUBLIC_MAP_ENABLED=true.
On desktop and tablet, the top-left three-line button collapses or expands the simplified sidebar, section headers fold individual groups, and Dock left/right in the footer chooses the sidebar side. The sidebar starts with navigation rather than repeating the app brand. On phones, the same top-left button opens the menu as an overlay, while the bottom navigation keeps Home, Search, Create, and Recent one tap away.
Use Cmd+K / Ctrl+K to open the command palette from anywhere. It groups destinations across navigation, discovery, personal, reference, and admin areas, then searches articles in the same panel when you type a query.
Navigation
Discover
Personal
Tools
Article structure
ADMIN_SECRET at /admin; works alongside user accountsdocs/offline-pwa.md and /api/offline/contract cover install prompts, offline reading, stale indicators, retry queues, mobile QA, draft warnings, and privacy limitsdocs/mobile-polish.md and /api/mobile-polish cover responsive QA, touch targets, safe areas, overflow/clipping checks, dialog bounds, and mobile help screenshot slotsdocs/desktop-app-research.md and /api/desktop-research cover local packaging tradeoffs, deployment recipes, filesystem import/export UX, and the research-only v5 decisiondocs/accessibility.md and /api/accessibility cover keyboard/focus/dialog/dropdown/control audits, widget summaries, contrast/motion checks, contribution guidance, and release blockersdocs/security-review.md and /api/security/review cover browser headers, reviewed surfaces, abuse-case gates, supply-chain checks, and the pre-v5 threat-model draftdocs/privacy-controls.md and /api/privacy/controls cover deployment modes, retention defaults, user export/deletion planning, and warnings for AI, webhooks, exports, feeds, and indexingdocs/secure-marketplace-plugins.md and /api/marketplace/security cover unsafe pack rejection, blocked permissions/hooks, dangerous plugin capabilities, provenance checks, and local-only installationdocs/marketplace-beta.md and /api/marketplace/beta cover beta metrics, featured/recent/recommended packs, collections, compatibility badges, search facets, install-intent steps, and limitationsdocs/marketplace-lifecycle.md and /api/marketplace/lifecycle cover pack states, transitions, local inventory, health checks, preview media validation, update metadata, compatibility warnings, and rollback guidancedocs/marketplace-authoring.md and /api/marketplace/authoring cover author dashboard metadata, README generation, checklist coverage, compatibility matrix output, quality expectations, and submission templatesdocs/template-marketplace.md and /api/marketplace/templates cover template-pack listings, included schema, category and article previews, compatibility notes, diff/merge contracts, and export-from-space fixture outputdocs/sync-manifests.md and /api/sync-manifests cover source/target manifests, checksums, dry-run reports, signed snapshot plans, staging promotion checks, and the network-federation release gatedocs/external-references.md and /api/external-references cover imported/mirrored provenance labels, broken-reference diagnostics, and public index privacy planningdocs/archive-mirror-workflows.md and /api/archive-mirrors cover read-only archive snapshots, private mirrors, selected-space transfers, repeated-sync conflict notes, and the pre-v5 federation decision checkpointdocs/migration-readiness.md and /api/migration-readiness cover blocking migration dry runs, backup prompts, schema compatibility reports, restore validation, representative v4 upgrade paths, and failure recovery guidancedocs/backup-restore.md and /api/backup-restore cover admin backup wizard sections, restore rehearsal validation, scheduled backup planning, external storage notes, and disaster-recovery drill guidancedocs/v5-upgrade-planning.md and /api/upgrade-assistant cover v5 readiness checks, pre-upgrade diagnostics, post-upgrade smoke checks, compatibility warnings, and release-note/migration doc linksdocs/test-quality-gates.md and /api/test-quality cover expanded test surfaces, stable QA fixtures, CI matrix planning, warning policy, and release-manager dashboard planningdocs/e2e-smoke-suite.md, /api/e2e-smoke-suite, and e2e/smoke-suite.spec.ts cover product smoke flows, responsive routes, fixture seeding, and failure screenshots/tracesdocs/release-gate-automation.md, /api/release-gates, and scripts/verify-docs-sync.mjs cover release candidate gates, docs sync verification, checklist metadata, known issues, and blocker labelsdocs/index.md, docs/maintainer-guide.md, and /api/documentation-onboarding cover maintainer docs, setup paths, troubleshooting, docs IA, and practical link-test coveragedocs/in-app-onboarding.md, /api/in-app-onboarding, and examples/onboarding/demo-content-pack.json cover first-run setup, guided admin onboarding, contextual help panel planning, demo content, and screenshot checkpointsdocs/example-site-recipes.md, /api/example-site-recipes, and examples/recipes/site-recipes.json cover setup recipes, env snippets, screenshot targets, pack recommendations, migration stories, and v5 readiness checksdocs/feature-freeze.md, /api/release-freeze, and docs/known-issues.md cover freeze policy, rehearsal matrix, blocker labels, v5 gate ownership, and release-note draft sectionsdocs/release-candidate-one.md, /api/release-candidate-one, and docs/rc-feedback-template.md cover RC1 gates, deployment validation, starter/pack/import/export validation, review checklists, and feedback reportingdocs/final-release-gates.md and /api/final-release-gates cover RC fixes, final beta freeze contracts, gate evidence, compatibility targets, correction windows, and stable v5 release gatesNEXT_PUBLIC_* environment variables/api/customization, public grouped config, supported env vars, style presets, color themes, layouts, reusable component catalog, editor control contract, collaboration UX contract, public API v1 contract, SDK type contract, webhook reliability contract, operations dashboard contract, maintenance tooling contract, observability contract, performance budget contract, cache strategy contract, offline/PWA contract, mobile polish contract, desktop research contract, accessibility finish contract, migration readiness contract, backup/restore contract, upgrade assistant contract, test quality gates contract, e2e smoke suite contract, release gate automation contract, documentation onboarding contract, in-app onboarding contract, example site recipes contract, feature freeze contract, release candidate one contract, final release gate contract, security review contract, privacy controls contract, marketplace security contract, marketplace beta contract, marketplace lifecycle contract, marketplace authoring contract, template marketplace contract, sync manifest contract, external reference contract, archive mirror contract, component slot contracts, persisted space customization contract, marketplace registry/import-preview metadata, plugin manifest schema/examples/compatibility matrix, plugin manifests, theme packs, template packs, migration guidance, and theme hooks for self-hosters and pluginsplugin.json manifests only when ARKIVEL_ENABLE_TRUSTED_PLUGINS=true and ARKIVEL_TRUSTED_PLUGIN_DIR points to an absolute local directory. Review permissions, routes, widgets, hooks, compatibility, source, and load errors before enabling a plugin.examples/plugins/starter-plugin/, validate with npm run plugin:validate -- path/to/plugin.json, list supported surfaces with npm run plugin:validate -- --list-surfaces, and use docs/plugin-authoring.md plus examples/plugins/marketplace-listing-template.json for compatibility notes and submission prep.docs/portable-bundles.md defines the full-site bundle manifest, checksums, source metadata, export scope, privacy filters, and dry-run import report before v5. Sessions, API keys, and analytics are excluded by default./api/export/history lists recent admin export reports, and /api/export/history?download=1 downloads the report JSON. Export manifests include file counts, byte counts, checksums, warnings, omitted private data, format, status, and scope.docs/audit-trail.md documents immutable event coverage, actor/target/workspace/severity/date filters, redacted JSON exports, alert hooks, and retention defaults.docs/moderation.md covers discussion reports, reviewer-only visibility, suggestion review actions, public contribution spam scoring, and rate-limit planning./api/import/rehearsal previews dry-run import reports with conflict categories, recommended actions, blocked changes, rollback plans, and fixture profiles. v4.81.2 rehearsals are intentionally no-write.docs/workspaces.md covers bootstrap profiles, invitations, scoped APIs, marketplace selections, and the single-workspace migration path.docs/role-templates.md covers role templates, permission matrices, invitation resend/revoke audit events, API-key behavior, and self-host admin recovery.docs/private-team-knowledge-base.md covers private workspace setup, collaboration controls, user preferences, and public-surface visibility checks for RSS, Atom, sitemap, and API v1.docs/editorial-governance.md covers review governance, claim queues, verification stamps, ownership/escalation paths, and release-blocker summary cards./api/categories/:id/customization and /api/articles/:id/customization resolve global, parent category, category, and article overrides for appearance, component pack, template pack, navigation, and metadata schema. Public reads hide privateDraftConfig; admin PUT requests validate and persist overrides./api/space-templates returns built-in personal wiki, product docs, team handbook, worldbuilding bible, research notebook, reading archive, project knowledge base, and public documentation templates. /space-templates/:id previews each starter space, and POST /api/space-templates previews imported template JSON or a one-click local import preview for a templateId before any future apply flow; authoring notes live in docs/space-templates.md./api/space-workflows and docs/domain-workflows.md describe docs portal, team handbook, worldbuilding, research, and personal wiki workflow controls, steps, starter template links, and release gates./api/categories/:id/governance stores inherited owner, reviewer, default visibility, review cadence, stale-page threshold, and required health signals. Article pages show inherited governance badges; the admin dashboard summarizes stale pages, draft/review articles, and configured health widgets.html[data-layout="..."] hooksnpm run marketplace:generate-component-pack, npm run marketplace:validate-pack, examples/marketplace/component-pack, and docs/component-pack-preview-harness.md to scaffold, validate, document, and plan preview-safe packsNEXT_PUBLIC_ARKIVEL_STYLE to classic-wiki or atlas-modern, then rebuild/redeploy because NEXT_PUBLIC_* values are build-time configNEXT_PUBLIC_ARKIVEL_COLOR_THEME to standard, forest, or ember, then rebuild/redeploy because NEXT_PUBLIC_* values are build-time configNEXT_PUBLIC_ARKIVEL_LAYOUT to classic-wiki, docs-portal, team-knowledge-base, worldbuilding-atlas, or research-notebook.env, .env.local, Vercel, or Docker Compose values; /admin/marketplace filters the versioned local registry, opens item detail panels, copies env vars/pack JSON/plugin manifests/install notes, and previews pasted/uploaded pack JSON with schema, source, license, checksum, token diff, and validation healthdocs/marketplace-contributions.md, examples/marketplace/, and the GitHub marketplace issue templates when preparing preview-safe style, theme, layout, component, plugin, or template pack submissionsDocumentation and versioning are part of every release. User-visible, API, schema, configuration, workflow, design, or contributor-guidance changes should update the matching references in the same commit.
README.md, CHANGELOG.md, ROADMAP.md, DESIGN.md, ARCHITECTURE.md, CONTRIBUTING.md, and AGENTS.mddocs/help.md, docs/features.md, /help, /features, and /api-docs when relevantpackage.json and package-lock.json; patch for docs/process/UI copy, minor for new capabilities, major for breaking changesvX.Y.Z: imperative summary, dependency commits keep build(deps): ..., and non-version commits use a short imperative subject@username mentions in discussions trigger a notification/feed.xml/feed/atom/api/v1/ with X-API-Key authentication. See API Documentation./api/graphql — interactive GraphiQL playground at the same URL (GET). Supports queries for articles, categories, tags, revisions, search, and wiki stats./api/admin/operations?bundle=1 provide admin-only health and diagnostic data for operators./api/admin/maintenance/report provides admin-only upgrade readiness, cleanup queue, and background pause data./api/admin/observability and /api/observability/metrics provide structured event feed and metric ingestion data./api/admin/performance provides route budget status, large-wiki fixtures, slow samples, and slow-query review data./api/admin/cache provides admin-only cache status, invalidation rules, stale warnings, and manual invalidation actions./api/offline/contract provides public install metadata, service-worker cache rules, stale indicators, retry queue limits, mobile QA checkpoints, draft warnings, and privacy limits./api/mobile-polish provides responsive QA checkpoints, mobile regression checks, and screenshot slot metadata./api/accessibility provides accessibility audit surfaces, screen-reader summaries, contrast/motion checks, and v5 blocker metadata./api/security/review provides browser header metadata, reviewed security surfaces, abuse-case gates, dependency review checklist, and the pre-v5 threat-model draft./api/privacy/controls provides deployment-mode controls, retention settings, user data export/deletion planning, and warnings for AI/external integrations./api/marketplace/security provides blocked permissions/hooks, dangerous plugin capability warnings, provenance requirements, and local-only installation guidance./api/marketplace/beta provides beta metrics, featured/recent/recommended pack ids, collections, compatibility badges, search facets, install-intent steps, and limitations./api/marketplace/lifecycle provides pack states, allowed transitions, local inventory, health checks, preview media validation, update metadata, compatibility warnings, and rollback guidance./api/marketplace/authoring provides author dashboard sections, README/checklist generation metadata, compatibility matrix rows, docs completeness checks, and submission template references./api/marketplace/templates provides template-pack previews, included schema, compatibility notes, diff/merge contracts, and export-from-space fixture output./api/sync-manifests provides source/target manifest metadata, section checksums, dry-run reports, signed snapshot planning, staging promotion guidance, and the network-federation release gate./api/external-references provides cross-instance reference metadata, provenance labels, diagnostics, and privacy-safe public index planning./api/archive-mirrors provides read-only archive snapshot, private mirror, selected-space transfer, repeated-sync conflict, and federation decision metadata.Global
| ? | Show keyboard shortcuts overlay (categorized modal) |
| / | Focus search bar |
| R | Toggle reading mode on article pages |
| g then h | Go to home page |
| g then a | All articles |
| g then n | New article |
| g then s | Search page |
| g then r | Recent changes |
| g then g | Article graph |
| Esc | Close dialog / blur input |
In the editor (Ctrl = Cmd on Mac)
Ctrl+B | Bold |
Ctrl+I | Italic |
Ctrl+Shift+X | Strikethrough |
Ctrl+Shift+L | Insert wiki link |
Ctrl+Shift+F | Insert footnote |
Ctrl+Shift+7 | Ordered list |
Ctrl+Shift+8 | Bullet list |
Ctrl+Shift+B | Blockquote |
Ctrl+Shift+E | Code block |
Ctrl+Z / Ctrl+Shift+Z | Undo / Redo |
[[ anywhere in the editor to search and link to existing articles. Type / to open the slash command menu for rich content blocks.