Languages

Sensedia Docs supports multilingual documentation, allowing you to reach a wider audience.

📋 Table of Contents

1. Introduction
2. Creating Language Versions
3. Publishing Translations
4. Best Practices
5. FAQ

Introduction

Sensedia Docs allows you to create and manage documentation in multiple languages. This is essential for reaching a global audience and ensuring that your content is accessible to users in their preferred language.

📚 Creating Language Versions

Basic Structure

To create a new language version of your documentation, follow these steps:

1. Create a New Directory: For each language, create a new directory under example/docs/en/. For example, for Spanish, create example/docs/es/.
2. Copy Existing Files: Copy the existing Markdown files from the English directory to the new language directory.
3. Translate Content: Translate the content of each Markdown file into the target language.

Example Directory Structure

Publishing Translations

Build process is managed by Sensedia Docs CLI, which automatically detects language directories and publishes them accordingly. Ensure to have keep the document name equal across languages It's important to maintain the same file names across different language directories to ensure proper linking and navigation.

Best Practices

1. Consistent Structure: Maintain a consistent directory structure across all language versions to simplify navigation and management.
2. Regular Updates: Keep all language versions up to date with the latest content changes to provide a uniform experience for all users.
3. Use Language Codes: Use standard language codes (e.g., en, es, pt-BR) for directory names to ensure clarity and consistency.

FAQ