Hello, and welcome to the Ox wiki.

I want to document the ins and outs of the Ox editor to help guide you from installation to usage to configuration.

I aim for Ox to be a lightweight editor which can be configured to push it towards replacing some of the more heavy editors that may be in your toolbelt as a programmer.

If you feel any part of this documentation is vague or incorrect, please feel free to open an issue.

The first step is installing the editor.

Just a note, by far the best way to install this editor is by compiling from source using cargo.

Other sources are very likely to be out of date.

Please see Installation for more information on how to install Ox.

So, you can now query ox from your command line, it's time to start it.

You can see Command Line Interface on how to start Ox

So, now you've opened Ox, it's time to get to grips with the basics of editing files

Go to General Editing on how to navigate and edit files within the editor

So, you are able to open files in ox, edit them, save them and maybe even know some more advanced tricks.

If you don't like the existing colour scheme, or perhaps want to change how things show up, then it may be possible through configuration.

You can also at this stage start writing plugins to introduce functionality to make the editor more comfortable for your usage.

Coming soon: a whole host of built in plugins included in the repository for your usage

Go to Configuration on how to navigate and edit files within the editor

If you're looking for what is in store in future versions, consider looking at the Roadmap