Skip to content

karlito40/mindo

Repository files navigation

Mindo

Organize your to-dos using a simple plain text format and preview them as a mindmap

Preview

✨ Features

  • πŸ“ Manage your todos through a plain mindo text file
  • 🧠 Update task status using a simple, easy-to-learn format β€” understandable in under a minute
  • 🌈 Syntax highlighting based on task status
  • βš™οΈ Easy setup via command: Mindo: Open
  • πŸ‘ Preview your tasks as a mindmap via command: Mindo: Show View
  • πŸ–Ό Export as PNG or SVG
  • πŸ“ Multiple .mindo file can be used in a single project

πŸš€ Usage

  1. Open the Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
  2. Run: Mindo: Open
  • Or bypass these steps by creating a .mindo or MINDO file manually
  1. Create a task using Alt+enter. See the shortcuts section
  2. Run: Mindo: Show View while focused on a Mindo file. The associated mindmap appear
  3. Update your task inside the mindo file. Start one with Alt+s or complete one with Alt+d while focused on a line
  4. The mindmap should auto update at the same time
  5. That's it ! You are a now a Mindo master

Format

Symbols are used to control task statuses. Add one at the beginning of a line to update it ‡️

  • - : a simple text
  • - ☐: an idle task
  • - β–Ά: a started task
  • - βœ”: a completed task

Mindo uses indentation to organize tasks: adding 2 more spaces than the parent task creates a new section in the mindmap preview

Working example ‡️

- Welcome
  - ☐ Mindo
    - Organize your tasks
    - β–Ά Test
      - ☐ Execute command "> Mindo: Open"
      - β–Ά Shortcuts
        - On Mac
          - ☐ cmd + Enter to create a task (or revert)
          - ☐ Option + s to start a task (or revert)
          - ☐ Option + d to complete a task (or revert)
        - On Others
          - ☐ ctrl + Enter to create a task (or revert)
          - ☐ Alt + s to start a task
          - ☐ Alt + d to complete a task
      - ☐ Live preview it
        - ☐ Execute command "> Mindo: Show View"
        - ☐ Check auto update on changes
  - β–Ά Support
    - Ask me on github
      - https://github.com/karlito40/mindo/issues
    - Contributions are welcome
    - β–Ά Be kind
  - βœ” Enjoy your life
  - And thanks

Commands and shortcuts

It adds 5 commands to the command palette:

'Mindo: Open' // Open or create your main project's mindo file
'Mindo: Show View' // Open the mindmap visualizer on the focus editor
'Mindo: Toggle Task' // Create a task or transform it into a simple label
'Mindo: Toggle Start' // Toggle started symbol
'Mindo: Toggle Done' // Toggle done symbol

It adds 4 shortcuts when editing a Mindo file:

'Cmd/Ctrl+Enter' // Triggers `Mindo: Toggle Task`
'Alt+Enter' // Triggers `Mindo: Toggle Task`
'Alt+D' // Triggers `Mindo: Toggle Done`
'Alt+S' // Triggers `Mindo: Toggle Start`

Render Demo

Screenshot

Support

Don't hesitate to fill an issue on github https://github.com/karlito40/mindo/issues. I will try my best to help.

Release Notes

  • 0.3.0 Fix webview not loading on production
  • 0.2.0 Add PNG export
  • 0.1.0 Add SVG export and force dark theme
  • 0.0.0 Initial release

Final

Thanks & Enjoy!

Hope it serves you well as it does for me

About

Mindmap + TODOs = πŸš€πŸ”₯

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published