An open translation management platform for teams
Simple, fast, and developer-friendly.

---

This repository contains the official documentation for Localine, an open-source translation management platform for teams.

The documentation is built using Mintlify and is hosted at localine.mintlify.app.

---

🚀 Development

To preview the documentation locally, you need to install the Mintlify CLI.

Prerequisites

• Node.js (version 18 or higher)
• npm

Installation

npm i -g mint

Local Preview

Run the following command at the root of this repository:

mint dev

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

---

📁 Structure

• docs.json: Configuration for the documentation (navigation, theme, etc.).
• index.mdx: The introduction page for the documentation.
• changelog.mdx: The changelog page listing updates and releases.
• installation/*: Guides related to installation.
• configuration/*: Guides related to configuration.

---

🤝 Contributing

Contributions to the documentation are welcome! If you find a typo, outdated information, or want to add a new guide:

1. Fork the repository
2. Clone your fork (git clone https://github.com/your-username/localine-docs.git)
3. Create a branch for your changes (git checkout -b typo/getting-started)
4. Commit your changes (git commit -m 'typo: fix typo in getting-started page')
5. Push to the branch (git push origin typo/getting-started)
6. Submit a Pull Request with a clear description of your improvements.

---

📝 License

This documentation is licensed under the MIT License. See the LICENSE file for details.