docs: update README and settings guide for v2 (editing strip, Dataview, file paths); fix package metadata
This commit is contained in:
1 parent
9a1a1dd150
commit
fae8b68647
4 files changed
+23
-17
No files matched your search
@@ -1,4 +1,4 @@
|
||||
# Obsidian Menus
|
||||
# Monster Menus
|
||||
Create simple, stylable menus from code blocks. Write links inside a menu code block, and the plugin renders a clean set of clickable items.
|
||||
|
||||
## Quick Start
|
||||
@@ -38,11 +38,11 @@ layout: slate small
|
||||
[Resources](https://example.com)
|
||||
```
|
||||
|
||||
Without a `layout:` line, the menu uses the default layout chosen in the plugin settings.
|
||||
Without a `layout:` line (or with only modifiers, like `layout: small`), the menu uses the default layout chosen in the plugin settings.
|
||||
|
||||
## Options
|
||||
|
||||
Customize any menu with `key: value` lines before the links:
|
||||
Customize any menu with `key: value` lines (put them before the links for readability):
|
||||
|
||||
| Option | Effect |
|
||||
|---|---|
|
||||
@@ -107,7 +107,7 @@ hover-text: #0af
|
||||
|
||||
## Dataview Integration
|
||||
|
||||
Generate links dynamically from Dataview queries. Prefix your query with `dataview:` or `dv:`:
|
||||
Generate links from a Dataview query (requires the Dataview plugin). Start the query with `dataview:` or `dv:`. Everything after that line is part of the query, so put it last:
|
||||
|
||||
```code
|
||||
layout: default
|
||||
@@ -115,7 +115,11 @@ layout: default
|
||||
dataview: LIST FROM "Projects"
|
||||
```
|
||||
|
||||
The plugin unwraps Dataview results so links blend seamlessly into your menu layout.
|
||||
Dataview's links join the menu row and take the layout's style. Per-link-type options apply too: note links count as `internal-`, everything else as `external-`.
|
||||
|
||||
## Editing a Menu
|
||||
|
||||
In Live Preview, clicking a menu link follows it instead of opening the code block. The code block's border and `</>` button are hidden; to edit the menu, click the thin strip (0.5rem) on the menu's left edge. The cursor changes to a question mark over it.
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
Reference in new issue
Block a user