Skip to content

joshuakto/obsidian-cardify

Repository files navigation

Obsidian Cardify Plugin copy-plus

Obsidian Downloads

Separates contents in a markdown, assign internal links to each separated content, and generate subsequent linked markdowns. Making it easy to drag and drop individual linked markdown files onto canvas.

Demo

Desktop (Mac)

obsidian.demo.mov

iPadOS

Adding cardify generate card command to toolbar and using added shortcut.

RPReplay_Final1708955498.MP4

Android

Using ribbon bar icon to trigger generation of cards on android app.

screen-20240226-213336.2.mp4

Cardify has these basic functionalities

  • Selection of separator (currently only supports two new lines or ---).
  • Detect whether an internal link exists in the content, if not assign automatically.
  • Create a markdown for each separated content (while preserving the frontmatter).
    • Give an index for the created page based on the position of the separated contents.
    • Extract comment from content to use as title for the created page
  • Create a folder to store the created markdown.
  • Generate and insert an internal link to replace the current selection.

Planned functionalities

  • Switch for toggling function to automatically assign internal links.
  • List of regex arranged in order of priority to use as title of the created markdown.
  • Allow users to view instruction for using the plugin in a popup modal.
  • Allow users to see the preview for the cards to be generated from the active file.

How to use

  1. Upon installation, an icon with overlapping squares(copy-plus) will be visible on the ribbon.
  2. Navigate to the markdown file you want to Cardify.
  3. Clicking the icon with overlapping squares(copy-plus) will generate a folder named the same as the active file and store created markdowns in it. Note: Currently, the plugin will change the content of the markdown when inserting internal link. If the spacing of the document is important, do not use this plugin for now. In the future there will be an option to choose whether you want to modify content of existing files.

"Buy Me A Coffee"

Acknowledgements

This plugin is built using Obsidian Sample Plugin as a template.