Welcome by pkm-outliner

Documentation and changelog

View on GitHub

PKM Outliner

PKM Outliner is a personal knowledge management (PKM) tool designed for thinkers, writers, and developers who prefer an outliner-style workflow. It helps you structure your thoughts, connect ideas, and navigate your knowledge base with speed and efficiency.

The application is built on a “Central Note” concept, allowing you to visualize and interact with its relationships—seeing parent notes (Uppers) and child notes (Downers) at a glance. This provides a powerful way to build and explore your personal wiki.

Core Concepts

Features

Getting Started

  1. Open index.html: Open the index.html file in your web browser to start the application.
  2. Create Your First Note: Begin typing in the editor to create your first note.
  3. Link to a New Note: Type [[New Note]] and then click the link to create and navigate to “New Note”.
  4. Explore with Keyboard Shortcuts: Use the arrow keys to navigate and Shift+Enter to toggle edit mode. (See all shortcuts below).

Keyboard Shortcuts

| Key | Action | | :— | :— | | Arrow Up / Arrow Down | Navigate through the note list. | | Arrow Left / Arrow Right | Navigate between parent, center, and child notes. | | Alt + Arrow Left/Right| Go back/forward in history. | | Space / Enter | Open or center the selected note. | | Tab | Switch focus between the navigation and content panes. |

Editing & Organization

| Key | Action | | :— | :— | | Shift + Enter | Toggle Edit Mode. | | [[ | Trigger auto-complete for linking. | | F2 | Rename the current note. | | Ctrl + Up/Down | Link selected notes as Parents/Children. | | Backspace | Unlink selected notes. | | Ctrl + Backspace | Delete selected notes. |

Tools

| Key | Action | | :— | :— | | / | Quick Search by title. | | Ctrl + Shift + F | Search by content. | | Ctrl + J | Go to Today’s Journal. |

Recent Updates (v0.7.3)

This version includes general maintenance and stability improvements. Recent feature additions include the Mentions view to see all backlinks to a note and context highlighting when navigating from a mention.


This README was generated based on the project’s documentation.