Clean and simple todo app built for Todo.txt format
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
.vscode
app
build
.babelrc
.eslintrc
.gitignore
README.md
main.js
package-lock.json
package.js
package.json
server.js
webpack.config.base.js
webpack.config.development.js
webpack.config.production.js

README.md

TodoX

A simple but smart note-taking app

TodoX is a little app that you can use as a quick note taking or todo app.

  • Small and simple, the only UI is the text you type
  • Saves on-the-fly, no need to manually save
  • Automatic indenting
  • Note-folding
  • Use checkboxes to keep track of your TODO's
  • Powerful keyboard control
  • Replaces common syntax with symbols, such as arrows
  • Free

Shortcuts

  • cmd/ctrl+up - move current line up
  • cmd/ctrl+down - move current line down
  • cmd/ctrl+d - delete current line
  • cmd/ctrl+w/q - close application
  • cmd/ctrl +/= - zoom text in
  • cmd/ctrl - - zoom text out
  • cmd/ctrl+0 - reset text size
  • cmd/ctrl+]/[ - fold note collapsing
  • cmd/ctrl+f - search (you can also use regular expressions, by starting and ending with a /)
  • shift+cmd/ctrl+f - replace
  • shift+cmd/ctrl+r - replace all
  • cmd/ctrl+g - jump to line (you can also use : notation, or go relative lines with + and -)
  • cmd/ctrl+/ - Add or toggle a checkbox
  • f11 - Toggle fullscreen
  • cmd/ctrl+i - Toggle between light and dark theme
  • alt - show or hide menu (Windows only)
  • cmd/ctrl+s - ...this does nothing.

Installation

# Download from git
git clone https://github.com/mfyz/todox.git

# Install dependencies
cd todox && npm install

# build and run
npm build
electron main.js

# or run dev version
npm run dev

Command Line Arguments

Portable Mode -p, --portable

Lets you store all the files TodoX generates in a specified location, such as a USB-stick or other portable storage device. In this mode both the configuration files as well as your text content will be stored in a "userdata" directory alongside the TodoX executable, or when given a directory as an argument, will store the files there.

You can also use this to store the TodoX configuration files, and the text content, in a synced cloud storage folder.

# run TodoX in portable mode, saving data in application directory.
todox --portable
# run TodoX in portable mode, saving data in custom directory.
todox --portable ~/todox_data

help -h, --help

Prints help information

FAQ

Where is my data saved?

Your data is saved in a plain text file content.txt. On Mac and Linux, this file is saved in ~/.todox. On Windows this file is saved in a directory called ".todox" in your userprofile directory.

Can my data be saved in an alternate directory?

Yes! See the portable mode section under the Command Line Arguments heading above.

Credits

TodoX is a manual fork export of FromScratch (https://fromscratch.rocks) created by Kilian Valkhof https://github.com/Kilian which is originally licensed under MIT license. TodoX includes many improvements and modifications to support and adapt Todo.txt format and extra capabilities.

TodoX is built upon these open source projects: Electron, React, Fira Code, CodeMirror and Electron-react-boilerplate.

Thanks @bittersweet @chentsulin @ctrauma for the initial contributions to FromScratch - indirectly to TodoX to be what it is today.