Skip to content

tkat0/obsidian-scrapbox-flavored

Repository files navigation

Obsidian Scrapbox Flavored

Scrapbox-flavored Grid View and Outliner for Obsidian

Note: This plugin is still in early alpha and is subject to change at any time!

Features

Grid View

Show files as cards with a thumbnail or a description

Command:

  • Open Scrapbox-flavored Grid View (default: Command + Shift + g)

You can explore pages in your vault efficiently.

Grid View provides several features.

  • Search files by file path or tags
  • Sort files
  • Pin starred files (Enable Starred Core plugin to use this)
  • Context menu to delete a file or toggle star

Related Pages

Show cards related to the current page at the bottom of the page

[Experimental] Styles

Provide Scrapbox flavored syntax.

This feature is disabled in default. Enable it in the setting.

Style Screenshot
quote in list
helpfeel in list

[Experimental] Outliner

Provide an effective list operations

This feature is disabled in default. Enable it in the setting.

The hotkeys can not be changed now.

Command (hotkey)
  • Create a list (Tab or Space)
  • Delete a list (Shift + Tab or Backspace)
    • Move cursor to the beginning of the line (default: Ctrl + a)
    • Move cursor to the end of the line (default: Ctrl + e)
  • Move up the current block of the list (default: Option + )
  • Move down the current block of the list (default: Option + )
  • Indent the selected block of the list (default: Option + )
  • Outdent the selected block of the list (default: Option + )
  • How to use

    This plugin has not been released officially yet.

    BRAT

    If you use BRAT (Beta Reviewers Auto-update Tester), you can try the plugin to specify tkat0/obsidian-scrapbox-flavored.

    See TfTHacker/obsidian42-brat: BRAT - Beta Reviewer's Auto-update Tool for Obsidian. Part of the Obsidian42 family of plugins. for details

    Copy manually

    • Download main.js, manifest.json and styles.css from Releases
    • Copy them to your vault VaultFolder/.obsidian/plugins/obsidian-scrapbox-flavored
    • Enable this plugin in the Obsidian configuration.

    Build manually

    • Download this repository
    • Run pnpm install && pnpm run build
    • Copy over ./packages/plugin/{main.js, manifest.json, styles.css} to your vault VaultFolder/.obsidian/plugins/obsidian-scrapbox-flavored
    • Enable this plugin in the Obsidian configuration.

    Roadmap

    These features will be implemented.

    Related projects

    Scrapbox and Markdown parser used in this plugin

    Obsidian Plugins of Scrapbox-like grid view

    Obsidian Plugins of Scrapbox-like list operation

    Acknowledgements

    Scrapbox

    This project was created based on Scrapbox. Thank you for creating the great product.