docs: update README and settings guide for v2 (editing strip, Dataview, file paths); fix package metadata

This commit is contained in:
olivier committed 2026-10-12 22:01:24 -04:00
1 parent 9a1a1dd150
commit fae8b68647
4 files changed
+23 -17

No files matched your search

+6 -4
View File
@@ -230,7 +230,7 @@ class MenuPluginSettingTab extends PluginSettingTab {
new Setting(containerEl)
.setName('Default layout')
.setDesc('Layout used when a menu block has no layout: line.')
.setDesc('Layout used when a menu block has no layout: line, or only modifiers (small, grid).')
.addDropdown(dropdown => {
for (const layout of LAYOUTS) {
dropdown.addOption(layout, layout.charAt(0).toUpperCase() + layout.slice(1));
@@ -248,7 +248,8 @@ class MenuPluginSettingTab extends PluginSettingTab {
const doc = containerEl.createEl('div', { cls: 'menu-settings-docs' });
doc.createEl('p', {
text: 'Put one link per line in a `menu` code block. Options go before the links.'
text: 'Put one link per line in a `menu` code block. Options go before the links. ' +
'To edit a menu in Live Preview, click the thin strip on its left edge.'
});
doc.createEl('h4', { text: 'Example' });
@@ -271,10 +272,11 @@ radius: 99px
tr.createEl('td', { text: syntax, cls: 'menu-settings-syntax' });
tr.createEl('td', { text: description });
};
addRow('[[Note]]', 'Opens an Obsidian note (Ctrl-click or middle-click: new tab)');
addRow('[[Note]]', 'Opens an Obsidian note (Ctrl-click or middle-click: new tab; Ctrl-hover: preview)');
addRow('[[Note|Alias]]', 'Obsidian note with custom display text');
addRow('[Text](https://...)', 'Opens URL in your browser');
addRow('[Text](file:///path)', 'Opens a local file or folder (desktop only)');
addRow('[Text](<file:///path with spaces>)', 'File path containing spaces');
doc.createEl('h4', { text: 'Options' });
const propTable = doc.createEl('table', { cls: 'menu-settings-table' });
@@ -290,6 +292,6 @@ radius: 99px
addProp('hover-text / hover-bg / hover-border', 'any CSS value', 'Hover colors');
addProp('size / gap / radius / padding', 'any CSS length', 'Font size, spacing, corner rounding');
addProp('internal-* / external-* / file-*', 'any CSS value', 'Color or font for one link type');
addProp('dataview: / dv:', 'Dataview query', 'Add links from Dataview (rest of block)');
addProp('dataview: / dv:', 'Dataview query', 'Add links from Dataview; the rest of the block is the query (needs Dataview)');
}
}