ohmyzsh

mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-21 15:23:14 +01:00

Table of Contents

This wiki is automatically published from ohmyzsh/wiki. To edit this page, go to ohmyzsh/wiki, make your changes and submit a Pull Request.

README: contains most of the stuff you need to start.
Wiki: for more in-depth knowledge about the project. It has many sections so check it out if you can't find what you're looking for.
FAQ: some definitions and solutions to common problems.
Settings: core Oh My Zsh settings are explained here. For settings for a particular plugin, see the plugin README.
Plugins: a list of all the current plugins, with a link to each plugin's README.
Themes: a list of all the available plugins with screenshots!
Contributing guide: if you want to contribute, read this before you start!

Zsh Home: contains links to many different Zsh resources.
FAQ: the Zsh project also has an FAQ.
Guide: an overview of Zsh for beginners. Kind of like a Getting started guide.
Docs: this contains more advanced information about Zsh.
Zsh Mailing List: the project has a mailing list where most of the stuff happens.

The zsh-users list is for asking questions as a user; the zsh-workers list is for asking questions as a developer of Zsh code.

I recommend joining the zsh-workers list and periodically reading the emails to push your knowledge further, even if sometimes you don't understand what you're reading. You can also use it to search if your question has already been answered by adding site:https://zsh.org/mla to your Google search.
IRC: even though most of the stuff happens in the mailing list, you can try asking questions in IRC if you need immediate feedback. You can also use the #zsh channel of this server.
man pages and info: you can browse the Zsh man pages (man zsh) or the info zsh guide. These are equivalent to searching the Docs website, but you might be more comfortable doing it from the command line.
The Troubleshooting section of the powerlevel10k theme's README has a lot of useful trivia about Zsh and terminals in general. The whole README is very useful, so even if it doesn't apply to what you're looking for, you'll probably learn a lot.

We post announcements, polls and some other stuff on:

We're an open source project and always in need of funding, so you can show your support by:

We have other stuff, have a look!