builderadmin
/
NoteDiscovery
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

added documentation

This commit is contained in:
Gamosoft 2025-12-17 09:12:42 +01:00
parent a9bb6d32fb
commit ad299deb79
3 changed files with 28 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -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 - 📄 **HTML Export** - Share notes as standalone HTML files
- 🕸️ **Graph View** - Interactive visualization of connected notes - 🕸️ **Graph View** - Interactive visualization of connected notes
- ⭐ **Favorites** - Star your most-used notes for instant access - ⭐ **Favorites** - Star your most-used notes for instant access
- 📑 **Outline Panel** - Navigate headings with click-to-jump TOC
## 🚀 Quick Start ## 🚀 Quick Start

8
docs/index.html
View File

@ -823,7 +823,7 @@
<div class="feature animate-on-scroll"> <div class="feature animate-on-scroll">
<div class="feature-icon">🔗</div> <div class="feature-icon">🔗</div>
<h3>Wikilinks</h3> <h3>Wikilinks</h3>
<p>Link notes with [[double brackets]] Obsidian-style. Broken links shown dimmed.</p> <p>Link notes with [[double brackets]] Obsidian-style. Jump to sections with [[note#heading]] anchors.</p>
</div> </div>
<div class="feature animate-on-scroll"> <div class="feature animate-on-scroll">
@ -850,6 +850,12 @@
<p>Star your most-used notes for instant access from the sidebar.</p> <p>Star your most-used notes for instant access from the sidebar.</p>
</div> </div>
<div class="feature animate-on-scroll">
<div class="feature-icon">📑</div>
<h3>Outline Panel</h3>
<p>Navigate headings with a click-to-jump table of contents. Link to sections with anchors.</p>
</div>
<div class="feature animate-on-scroll"> <div class="feature animate-on-scroll">
<div class="feature-icon">🔌</div> <div class="feature-icon">🔌</div>
<h3>Extensible</h3> <h3>Extensible</h3>

21
documentation/FEATURES.md
View File

@ -37,12 +37,31 @@
### Internal Links ### Internal Links
- **Wikilinks** - `[[Note Name]]` Obsidian-style syntax for quick linking - **Wikilinks** - `[[Note Name]]` Obsidian-style syntax for quick linking
- **Wikilinks with display text** - `[[Note Name|Click here]]` to customize link text - **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 - **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 - **Drag to link** - Drag notes or images into the editor to insert links
- **Click to navigate** - Jump between notes seamlessly - **Click to navigate** - Jump between notes seamlessly
- **External links** - Open in new tabs automatically - **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 ### Direct URLs
- **Deep linking** - Open specific notes via URL (e.g., `/folder/note`) - **Deep linking** - Open specific notes via URL (e.g., `/folder/note`)
- **Search highlighting** - Add `?search=term` to highlight specific content - **Search highlighting** - Add `?search=term` to highlight specific content