Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add Spanish README and Language Switcher #598

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

paolacernada
Copy link

@paolacernada paolacernada commented Aug 4, 2024

Description

This pull request introduces a Spanish translation of the README file, alongside a language switcher to toggle between the English and Spanish versions. The following changes have been implemented:

Changes

  • README Translation:

    • Created README.es.md to provide documentation in Spanish, improving accessibility for Spanish-speaking users.
  • Language Switcher:

    • Added a language switcher at the top of both README.md and README.es.md. This switcher includes links for users to easily switch between the two languages, enhancing the usability and inclusiveness of the documentation.

Implementation Details

  1. Translation of Documentation:

    • Translated all sections of the original README, ensuring that technical terms and instructions are accurately conveyed in Spanish.
  2. HTML Language Switcher:

    • Implemented an HTML snippet at the beginning of both README files, allowing seamless switching between English and Spanish.
<div style="text-align: right;">
  <a href="README.md">English</a> | <a href="README.es.md">Español</a>
</div>

Benefits

  • Enhanced Accessibility: By providing documentation in Spanish, we expand the reach of EasyMDE, making it more accessible to a broader audience.
  • Improved User Experience: The language switcher enables users to quickly toggle between languages, offering a smooth and intuitive experience.
  • Community Engagement: Catering to a diverse user base fosters community growth and engagement, potentially increasing contributions from non-English speaking developers.

How to Test

  • Verify the presence of README.es.md in the root directory.
  • Check that the language switcher links work correctly, navigating between README.md and README.es.md.
  • Review the Spanish translation for accuracy and completeness.

**Commit Message:**  
- Created a new `README.es.md` file with a complete Spanish translation of the original README.  
- Included detailed instructions for installation, configuration, and usage of EasyMDE.  
- Translated sections on toolbar customization, keyboard shortcuts, advanced use, and contributing guidelines.  
- Added information on the project's history and license details in Spanish.  

This commit introduces a fully translated README to better serve Spanish-speaking users and contributors.
add a language switcher button that allows users to switch between the English and Spanish versions of the README file
fixed link typo
add a language switcher button that allows users to switch between the English and Spanish versions of the Spanish version of the README file too
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant