Skip to content
A SaaS platform that runs in the background of your dev environment, creating documentation based on your workflow.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets/img
.gitignore
readme.md

readme.md

MindFlow.ai

Mindflow.ai is SaaS platform that runs in the background of your dev environment, and creates documentation based on your workflow.

Want to join our Alpha release?

Email me at arieg419@gmail.com and we'll get you set up ⚡️

Getting Started

These instructions will show you how to use Mindflow.

Quick Start

So far Mindflow.ai supports

Navigate to the timeline tab. It should be empty.

#gettingstarted

Git integration

  1. Navigate to the Home tab.

  2. Click on Open Timeline

  3. Select a directory with a .git directory.

#watchfile

Copying text

Copy some text to your clipboard. Now run Cmd-C (Ctrl-C for Windows or Linux). Flip back to Mindflow and navigate to the timeline tab. Now run 'Cmd-H' (Ctrl-H for Windows or Linux), You should see the text on the timeline.

#copytext

Copying images

Copy an image to your clipboard. Now run Cmd-I (Ctrl-I for Windows or Linux). Flip back to Mindflow and navigate to the timeline tab. You should see the copied image on your timeline.

#copyimages

Embed Youtube Videos

Embed a youtube video Go to youtube and copy the url of a video like this one to your clipboard https://www.youtube.com/watch?v=s1Rd4UShDxQ. Now run Cmd-Y (Ctrl-Y for Windows or Linux).

#copyvideo

Custom notes

Add a note

#customnotes

Drag and Drop timeline nodes

#dd

Search timeline**

#search

Watching JS files for changes

  1. Navigate to the Home tab.

  2. Click on watch a JS file

  3. Select a JS file to be watched.

  4. Edit JS file. The changes made to the file should now be reflected on your timeline. (This feature currently works on 1 file only)

#watchfile

Generate Documentation

  1. Navigate to timeline view.

  2. Run Cmd-G (Mac) or Ctrl-G (Windows)

#generate

Saving your timeline

Mindflow.ai creates a hidden .mf folder with your timelines data in a selected directory.

  1. To save your timeline, click on the save file button. You will be prompted to select a directory to save to.

  2. Once your timeline has been saved you can close Mindflow via the CLI (Ctrl-C) or GUI.

Loading previous timelines

  1. Open Mindflow.ai and navigate to the "Sources" tab.
  2. Click the button under existing timelines and navigate to the directory where you saved the timeline.
  3. Navigate to the "Timeline" tab to see your previous work.

Contributing

Found a bug? Want a specific feature implemented? Please open a github issue so we can git (😄) to it ASAP.

Thanks!

You can’t perform that action at this time.