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/search?q=...&explain=1 for per-result score explanationsOPENAI_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.
OPENAI_API_KEY./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/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/security-review.md covers browser headers, reviewed surfaces, abuse-case gates, supply-chain checks, and the pre-v5 threat-model draftdocs/secure-marketplace-plugins.md covers unsafe pack rejection, blocked permissions/hooks, dangerous plugin capabilities, provenance checks, and local-only installationdocs/external-references.md covers imported/mirrored provenance labels, broken-reference diagnostics, and public index privacy planningdocs/v5-upgrade-planning.md covers v5 readiness checks, pre-upgrade diagnostics, post-upgrade smoke checks, compatibility warnings, and release-note/migration doc linksdocs/index.md and docs/maintainer-guide.md cover maintainer docs, setup paths, troubleshooting, docs IA, and practical link-test coverageNEXT_PUBLIC_* environment variablesARKIVEL_SITE_MODE for the working wiki, or set it to product for the database-free product and documentation website/api/customization, public grouped config, supported env vars, style presets, color themes, layout presets, layout composition hooks, component packs, theme packs with the theme-pack schema, and marketplace registry items, contract, and validation metadata 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.docs/workspaces.md covers bootstrap profiles, invitations, scoped APIs, marketplace selections, and the single-workspace migration path.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/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 provides structured event feed and metric ingestion data./api/admin/performance provides route budget status, large-wiki fixtures, slow samples, and slow-query review data.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.