quickstart.html
93 lines · 6729 bytes
1<!DOCTYPE html>
2<html lang="en">
3<head>
4<meta charset="utf-8">
5<meta name="viewport" content="width=device-width, initial-scale=1">
6<title>Quick start · Orgstar</title>
7<meta name="description" content="From a fresh install to editing, scheduling and seeing your agenda.">
8<link rel="icon" href="favicon.svg" type="image/svg+xml">
9<link rel="stylesheet" href="theme.css">
10<link rel="stylesheet" href="syntax.css">
11<link rel="stylesheet" href="style.css">
12</head>
13<body>
14<header class="site">
15<a class="site-title" href="index.html">Orgstar</a>
16<nav>
17<a href="install.html">Install</a>
18<a href="#">Quick start</a>
19<a href="guide/index.html">Manual</a>
20</nav>
21</header>
22<main>
23<h1>Quick start</h1>
24<p class="lede">Add a folder of org files, open one, and learn the handful of keys you need first.</p>
25<nav class="toc" aria-label="On this page">
26<h2>On this page</h2>
27<ul>
28<li><a href="#add-a-folder">Add a folder</a></li>
29<li><a href="#choose-your-keys">Choose your keys</a></li>
30<li><a href="#open-a-file">Open a file</a></li>
31<li><a href="#write-an-outline">Write an outline</a></li>
32<li><a href="#see-your-agenda">See your agenda</a></li>
33<li><a href="#capture-a-thought">Capture a thought</a></li>
34<li><a href="#search">Search</a></li>
35<li><a href="#next">Next</a></li>
36</ul>
37</nav>
38<h2 id="add-a-folder">Add a folder</h2>
39<p>Choose File ▸ Add Folder… (<code class="verbatim">⇧⌘O</code>) and pick the folder that holds your org files. It appears in the sidebar, and Orgstar indexes every org file under it for search, the agenda and links. You can add several folders. Nothing is copied or moved.</p>
40<p>If you don't have org files yet, add an empty folder and create <code class="verbatim">notes.org</code> in it from Finder or the sidebar.</p>
41<h2 id="choose-your-keys">Choose your keys</h2>
42<p>Open Orgstar ▸ Settings… (<code class="verbatim">⌘,</code>) and pick <strong>Keys</strong> under General:</p>
43<ul>
44<li><strong>Emacs</strong>: Org's own bindings, <code class="verbatim">C-c C-t</code> and friends. The default.</li>
45<li><strong>Mac</strong>: standard Mac editing keys, with Org commands on <code class="verbatim">⌃⌘</code> combinations.</li>
46<li><strong>Doom (Vim keys)</strong>: modal editing as in Doom Emacs, with <code class="verbatim">SPC</code> as the leader.</li>
47</ul>
48<p><a href="guide/03-keys.html">Keys and commands</a> lists every binding in each preset. If you already use Emacs, Settings ▸ General ▸ Import from Emacs… reads your configuration: TODO keywords, agenda files, capture templates and more (see <a href="guide/13-configuration.html">Configuration</a>).</p>
49<h2 id="open-a-file">Open a file</h2>
50<p><code class="verbatim">⌘P</code> (Quick Open) finds a file by name; the sidebar works too. Open files become buffers: the tab bar and Switch to Buffer move between them.</p>
51<h2 id="write-an-outline">Write an outline</h2>
52<p>Type a heading and some text:</p>
53<pre><code class="language-org highlight"><span class="text org"><span class="markup heading org"><span class="punctuation definition heading org">*</span> Projects
54</span><span class="markup heading org"><span class="punctuation definition heading org">**</span> <span class="keyword other todo org">TODO</span> Write the report
55</span>SCHEDULED: <span class="constant other timestamp org"><2026-10-09 Fri></span>
56Draft the summary first.
57<span class="markup heading org"><span class="punctuation definition heading org">**</span> Reading list
58</span><span class="punctuation definition list org">- </span><span class="constant language checkbox org">[ ]</span> The Org manual
59<span class="punctuation definition list org">- </span><span class="constant language checkbox org">[ ]</span> This manual</span></code></pre>
60<p>With the Emacs keys:</p>
61<table>
62<thead>
63<tr><th>Key</th><th>What it does</th></tr>
64</thead>
65<tbody>
66<tr><td><code class="verbatim">TAB</code> on a heading</td><td>Fold or unfold it (cycles through folded, children, everything).</td></tr>
67<tr><td><code class="verbatim">S-TAB</code></td><td>Cycle the whole file the same way.</td></tr>
68<tr><td><code class="verbatim">M-RET</code></td><td>New heading (or list item) at the same level.</td></tr>
69<tr><td><code class="verbatim">M-<left></code> / <code class="verbatim">M-<right></code></td><td>Promote or demote the heading.</td></tr>
70<tr><td><code class="verbatim">C-c C-t</code></td><td>Cycle the TODO state.</td></tr>
71<tr><td><code class="verbatim">C-c C-s</code> / <code class="verbatim">C-c C-d</code></td><td>Schedule, or set a deadline, with the date picker.</td></tr>
72<tr><td><code class="verbatim">C-c C-c</code></td><td>Context action: toggle a checkbox, align a table, run a code block.</td></tr>
73</tbody>
74</table>
75<p>With the Mac preset, the Org commands are on <code class="verbatim">⌃⌘</code> keys (<code class="verbatim">⌃⌘T</code> cycles TODO, <code class="verbatim">⌃⌘S</code> schedules, <code class="verbatim">⌃⌘X</code> is the context action); with Doom, they're under <code class="verbatim">SPC m</code> (<code class="verbatim">SPC m t</code>, <code class="verbatim">SPC m d s</code>).</p>
76<p>The <a href="guide/02-the-editor.html">editor chapter</a> covers how Org markup is shown and hidden, and <a href="guide/04-outlines.html">Outlines and structure</a> covers headings and lists.</p>
77<h2 id="see-your-agenda">See your agenda</h2>
78<p>Window ▸ Agenda (<code class="verbatim">⇧⌘A</code>) shows what is scheduled or due across every indexed file, day by day, and the TODO list. Select an item to jump to it. See <a href="guide/07-agenda.html">The agenda</a>.</p>
79<h2 id="capture-a-thought">Capture a thought</h2>
80<p><code class="verbatim">⇧⌘N</code> opens capture from anywhere in the app. Until you define your own templates (in <code class="verbatim">~/.config/orgstar/capture.toml</code>, or imported from Emacs), there are two: <code class="verbatim">t</code> files a TODO and <code class="verbatim">n</code> a note, each under an <code class="verbatim">Inbox</code> heading in <code class="verbatim">todo.org</code> or <code class="verbatim">notes.org</code> in your first folder. See <a href="guide/08-capture.html">Capture</a>.</p>
81<h2 id="search">Search</h2>
82<p><code class="verbatim">⇧⌘F</code> searches the text of every indexed file. Results open at the matching line.</p>
83<h2 id="next">Next</h2>
84<ul>
85<li>The command palette (<code class="verbatim">⇧⌘P</code>) lists every command with its key.</li>
86<li>The <a href="index.html">chapter list</a> goes through every feature.</li>
87</ul>
88</main>
89<footer class="site">
90Orgstar is 0BSD-licensed. Source: <a href="https://gitbay.org/krz/orgstar">gitbay.org/krz/orgstar</a>.
91</footer>
92</body>
93</html>