❮ Z-Shell Wiki ❯

A Swiss Army Knife for Zsh Unix shell

---

This repository contains the source code for the Z-Shell Wiki, the official knowledge base and documentation for Zi and the Z-Shell ecosystem.

Built with Docusaurus, it provides a modern, fast, and searchable interface for Zsh users, developers, and maintainers.

🚀 Quick Links

• Live Wiki: Read the documentation online.
• Zi Plugin Manager: The core project.
• Community Discussions: Ask questions and share ideas.
• Localization (Crowdin): Help us translate the wiki into your language.

🛠️ Local Development

To run the wiki locally for testing or contribution:

Prerequisites

• Node.js (>= 20.x)
• pnpm (>= 10.x)

Steps

1. Clone the repository:

   git clone https://github.com/z-shell/wiki.git
   cd wiki

2. Install dependencies:

   pnpm install

3. Start the development server:

   pnpm start

The site will be available at http://localhost:3000.

📂 Project Structure

• docs/: Core documentation and getting started guides.
• community/: Community-driven guides and resources.
• ecosystem/: Documentation for Zi annexes and related plugins.
• blog/: Project updates and articles.
• src/: Custom React components and styles.
• static/: Static assets (images, fonts, etc.).
• i18n/: Localized content (managed via Crowdin).

✍️ Contributing

We welcome contributions! Whether it's fixing a typo, updating outdated information, or adding a new guide.

• Content Authoring: Refer to Docs Authoring Guidelines for standards on MDX, frontmatter, and file naming.
• Localization: Use Crowdin for translations. Do not modify files in i18n/ directly.
• Code of Conduct: Please follow our Code of Conduct.

🛡️ Security

Z-Shell follows good security practices. If you discover a security vulnerability, please refer to our Security Policy.

📄 License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0). See the LICENSE file for details.

---

Developed with ❤️ by the Z-Shell Community.