https://kaivalya.eu/projects/editor/en/docs/ Recent content in Documentation on Kaivalya Editor Hugo -- gohugo.io en https://kaivalya.eu/projects/editor/en/docs/first-steps/ Mon, 01 Jan 0001 00:00:00 +0000 https://kaivalya.eu/projects/editor/en/docs/first-steps/ Not installed yet? Install the editor first — it also says what spelling and git need on your system. This walks you through a first session, in order. Each step is a few keys; the pages linked at the end of each go deeper when you want them. Where this ends up: a project, a note in split view, its outline 1. Open a project Start the editor with no file — kaivalya-editor, or the launcher. https://kaivalya.eu/projects/editor/en/docs/how-to-guides/ Mon, 01 Jan 0001 00:00:00 +0000 https://kaivalya.eu/projects/editor/en/docs/how-to-guides/ Each section is one task, from start to finish. For what a feature does in full, see the User guide. Install the editor, and what it needs Prerequisites Kaivalya Editor runs on Linux, under Wayland or X11, and draws with the graphics card through Vulkan — any desktop from the last ten years has it. Everything else is optional: the editor opens without it, and the feature that needs it says so when you ask for it. https://kaivalya.eu/projects/editor/en/docs/user-guide/ Mon, 01 Jan 0001 00:00:00 +0000 https://kaivalya.eu/projects/editor/en/docs/user-guide/ The reference: every feature, what it does, how to use it and what it will not do, area by area. For a first walk through the editor, see First steps; for a task start to finish, the How-to guides; for why it works as it does, Understanding the editor. Every key, every setting and every row of the / palette are listed on their own in Keyboard shortcuts, Every setting and The / catalogue. https://kaivalya.eu/projects/editor/en/docs/settings-reference/ Mon, 01 Jan 0001 00:00:00 +0000 https://kaivalya.eu/projects/editor/en/docs/settings-reference/ Editor › Settings file (Ctrl+,) opens ~/.config/kaivalya-editor/settings.toml, which lists every option below with the same comment, so you rarely need this page. A setting not written in the file keeps the value shown here. A project can change any of them for itself in .kaivalya/settings.toml, writing only what differs — see A project’s own settings. This page is generated from the editor’s own defaults and comments each time the site is built. https://kaivalya.eu/projects/editor/en/docs/shortcuts/ Mon, 01 Jan 0001 00:00:00 +0000 https://kaivalya.eu/projects/editor/en/docs/shortcuts/ Every command the editor has, in the order of its menus. A command with no keys is in its menu only. The keys that move around the text — Home, End, Ctrl+Home, Ctrl+←, Page Up — are the text’s own and listed in First steps. This page is generated from the editor’s command table each time the site is built. File Command Keys Menu New file Ctrl+N File › New New whiteboard (. https://kaivalya.eu/projects/editor/en/docs/slash-catalogue/ Mon, 01 Jan 0001 00:00:00 +0000 https://kaivalya.eu/projects/editor/en/docs/slash-catalogue/ Type / at the start of a word in a markdown file to open the palette, keep typing to narrow it, Enter to take a row; The / palette explains how it behaves. Below is everything in it, group by group. Your own templates and the characters are added to it at run time and are not listed here. This page is generated from the editor’s catalogue each time the site is built. https://kaivalya.eu/projects/editor/en/docs/understanding/ Mon, 01 Jan 0001 00:00:00 +0000 https://kaivalya.eu/projects/editor/en/docs/understanding/ Why the editor works the way it does. To use a feature, see the User guide; for a task, the How-to guides. How the editor behaves, and why The pages of this guide each describe one part of the editor. A handful of rules run through all of them, and knowing them makes most of the editor’s choices predictable. Your files are the truth The task board is todo.md; a whiteboard is its .