Skip to content

OpaqueGlass/syplugin-hierarchyNavigate

Repository files navigation

Hierarchy Navigate

请点这里阅读中文说明

Most of this document was translated by Google Translate.

Add parent and children documents links under the document title.

Quick Start

  • Download from marketplace OR 1: Unzip the package.zip file in Release, 2: Move the folder to {workplace}/data/plugins/, 3: Rename the folder to syplugin-hierarchyNavigate;
  • Just turn on the plugin; (Marketplace--Downloaded--Plugin--Find this plugin, click switch icon)
  • For more information, please refer to the plugin setting page; (Marketplace--Downloaded--Plugin--HierarchyNavigate-- Click setting icon)
  • Documents with the og-hn-ignore attribute or attribute value will be ignored and the hierarchical navigation will not be displayed.
    • By using the og-hn-content attribute in the document, you can customize the display order of the current document's content. The attribute value is an array of strings, for example: ["info", "breadcrumb", "parent", "sibling", "previousAndNext", "backlinks", "child", "widget"].

Shortcut

Func Default Shortcut Recommended Shortcut Note
Open upper doc ⌥⌘← or Ctrl + Alt + ←
Open first subdocument ⌥⌘→ or Ctrl + Alt + →
Open previous doc ⌥⌘↑ or Ctrl + Alt + ↑
Open next doc ⌥⌘↓ or Ctrl + Alt + ↓
Insert the listChildDocs widget / ⌥⇧L or Shift + Alt + L Need download listChildDocs first

Other explanation

  • Maybe available in siyuan Android App (in testing);

  • After inserting the navigation part, the document icon on the left side of the title will have some misalignment, which can be solved by (1) Enable "Adjust the position of document icon" in this plugin settings or (2) "Settings - Appearance - Code Snippet - Add css"

    .protyle-title__icon {
        top: 40px;
    }

Feedback bugs

Please go to github repository to report problems.

References & Appreciations

For dependencies, please referpackage.json.

Developer/Project Description Illustration
UFDXD/HBuilderX-Light A borderless eye protection theme This plug-in is implemented by referring to the parent-child document information under its title
leolee9086 / cc-template Render template in widget; Mulan Permissive Software License,Version 2 Click to open the doc.
zuoez02/siyuan-plugin-system A 3-rd plugin system for siyuan
zxhd863943427&mozhux (赐我一胖) Suggestions or contributions about default style.
wetoria/DailyNotesWalker Shortcuts Quick View Previous Next Diary Refer to its idea and shortcut binding method
(qq) 八面风, 与路同飞, (Github) QQQOrange Assist in locating the issue