Coder Social home page Coder Social logo

quorafind / obsidian-outliner Goto Github PK

View Code? Open in Web Editor NEW

This project forked from vslinko/obsidian-outliner

0.0 0.0 0.0 6.54 MB

Work with your lists like in Workflowy or RoamResearch

License: MIT License

Shell 0.04% JavaScript 8.79% TypeScript 89.71% CSS 1.45%

obsidian-outliner's Introduction

Obsidian Outliner

GitHub Workflow Status GitHub release (latest SemVer)

Work with your lists like in Workflowy or RoamResearch

⁉️ Discuss ideas or ask a question
⚙️ Follow the development process
🐛 Report issues

Compatible with Obsidian Zoom plugin.

Demo

Demo

How to install

From within Obsidian

You can activate this plugin within Obsidian by doing the following:

  • Open Settings > Third-party plugin
  • Make sure Safe mode is off
  • Click Browse community plugins
  • Search for "Outliner"
  • Click Install
  • Once installed, close the community plugins window and activate the newly installed plugin

Manual installation

Download main.js, manifest.json, styles.css from the latest release and put them into <vault>/.obsidian/plugins/obsidian-outliner folder.

How to use

Try to create a deeply structured list and move items by pressing the hotkeys described below.

Features

Improve the style of your lists

If you liked the styles from the demo above, you can enable them in the plugin settings tab.

Disclaimer: Styles are only compatible with built-in Obsidian themes.

Setting Default value
Improve the style of your lists true

Move lists back and forth

Move lists with children wherever you want without breaking the structure.

Command Default hotkey (Windows/Linux) Default hotkey (MacOS)
Move list and sublists up CtrlShift CommandShift
Move list and sublists down CtrlShift CommandShift
Indent the list and sublists
Outdent the list and sublists
Setting Default value
Enhance the Tab key true

Draw vertical indentation lines

Demo of vertical indentation lines

Setting Default value
Draw vertical indentation lines false
Vertical indentation line click action Toggle Folding

Stick the cursor to the content

Don't let the cursor move to the bullet position. Affects cursor movement, text deletion, text selection.

Setting Default value
Stick the cursor to the content true

Enhance the Enter key

Make the Enter key behave the same as other outliners:

  • Enter outdents list item if it's empty.
  • Enter creates new line on children level if there are any children.
  • Shift-Enter creates a new note line.

More info

Setting Default value
Enhance the Enter key true

Fold and unfold your lists

Command Default hotkey (Windows/Linux) Default hotkey (MacOS)
Fold the list Ctrl Command
Unfold the list Ctrl Command

Enhance the CtrlA or CmdA behavior

Press the hotkey once to select the current list item. Press the hotkey twice to select the entire list.

Setting Default value
Enhance the Ctrl+A or Cmd+A behavior true

Debug mode

Open DevTools (Command+Option+I or Control+Shift+I) to copy the debug logs.

Setting Default value
Debug mode false

Unsupported (yet) features

Pricing

This plugin is free for everyone, however, if you would like to thank me or help with further development, you can donate in one of the following ways:

Patreon

Patrons & Supporters

I want to say thank you to the people who support me, I really appreciate it!

obsidian-outliner's People

Contributors

vslinko avatar miluoshi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.