From ad299deb79d5fcbbced27053d6ada9d004c9913e Mon Sep 17 00:00:00 2001 From: Gamosoft Date: Wed, 17 Dec 2025 09:12:42 +0100 Subject: [PATCH] added documentation --- README.md | 1 + docs/index.html | 8 +++++++- documentation/FEATURES.md | 21 ++++++++++++++++++++- 3 files changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1084e60..de341af 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,7 @@ If this project has been useful to you, consider supporting its development, it - πŸ“„ **HTML Export** - Share notes as standalone HTML files - πŸ•ΈοΈ **Graph View** - Interactive visualization of connected notes - ⭐ **Favorites** - Star your most-used notes for instant access +- πŸ“‘ **Outline Panel** - Navigate headings with click-to-jump TOC ## πŸš€ Quick Start diff --git a/docs/index.html b/docs/index.html index e57b741..05472dd 100644 --- a/docs/index.html +++ b/docs/index.html @@ -823,7 +823,7 @@
πŸ”—

Wikilinks

-

Link notes with [[double brackets]] Obsidian-style. Broken links shown dimmed.

+

Link notes with [[double brackets]] Obsidian-style. Jump to sections with [[note#heading]] anchors.

@@ -850,6 +850,12 @@

Star your most-used notes for instant access from the sidebar.

+
+
πŸ“‘
+

Outline Panel

+

Navigate headings with a click-to-jump table of contents. Link to sections with anchors.

+
+
πŸ”Œ

Extensible

diff --git a/documentation/FEATURES.md b/documentation/FEATURES.md index 62025b4..2f1a20a 100644 --- a/documentation/FEATURES.md +++ b/documentation/FEATURES.md @@ -37,12 +37,31 @@ ### Internal Links - **Wikilinks** - `[[Note Name]]` Obsidian-style syntax for quick linking - **Wikilinks with display text** - `[[Note Name|Click here]]` to customize link text +- **Section anchors** - `[[Note Name#heading]]` to link directly to a heading +- **Same-page anchors** - `[[#heading]]` to link within the current note - **Broken link detection** - Non-existent note links shown dimmed -- **Markdown links** - `[Note Name](note.md)` standard syntax also supported +- **Markdown links** - `[text](note.md)` standard syntax also supported +- **Markdown section links** - `[text](note.md#heading)` for heading anchors - **Drag to link** - Drag notes or images into the editor to insert links - **Click to navigate** - Jump between notes seamlessly - **External links** - Open in new tabs automatically +### Outline Panel +- **Table of Contents** - View all headings (H1-H6) in sidebar +- **Click to navigate** - Jump to any heading in edit or preview mode +- **Real-time updates** - Outline updates as you type +- **Hierarchical view** - Indentation shows heading structure +- **Heading count badge** - Quick indicator of document structure + +### Section Link Syntax +To link to a heading, convert the heading text to a slug: **lowercase, spaces β†’ dashes, remove special chars**. + +| Heading | Slug | Link Example | +|---------|------|--------------| +| `## Getting Started` | `getting-started` | `[[note#getting-started]]` | +| `### API Reference` | `api-reference` | `[API](note#api-reference)` | +| `## What's New?` | `whats-new` | `[[#whats-new]]` (same page) | + ### Direct URLs - **Deep linking** - Open specific notes via URL (e.g., `/folder/note`) - **Search highlighting** - Add `?search=term` to highlight specific content