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

Enhance Image Alignment in Farsi Introduction Document #212

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

hootanht
Copy link
Contributor

@hootanht hootanht commented Dec 31, 2024

This pull request improves the alignment and presentation of images in the CSI - White Paper - Introduction to CS Internship --farsi-ir.md file. By switching from Markdown image syntax to HTML, images can now be aligned to the right and set to a width of 100%, enhancing the readability and visual appeal of the Persian document.


Changes Made

  • File Modified: processes/documents/CSI - White Paper - Introduction to CS Internship --farsi-ir.md
    • Replaced Markdown image embedding with HTML <img> tags.
    • Set align="right" and width="100%" attributes for better image alignment and responsiveness.

Example Change:

- ![Description](path/to/image.png)
+ <img src="path/to/image.png" alt="Description" align="right" width="100%" />

Motivation

Proper image alignment is crucial for enhancing the readability and user experience, especially in right-to-left (RTL) languages like Persian. This change ensures that images are displayed consistently and aesthetically within the document, making it more user-friendly for our target audience.


Related Issues

  • Improves compliance with RTL language standards.

Reviewers

We can enhance the readability of our Persian document by adjusting its alignment. I believe @Ali-Sdg90 and @zahra-ahangari are currently working on it, so I’m including both of you in this discussion.


Testing

  • Verified that images align correctly to the right and scale appropriately across different devices and screen sizes.
  • Ensured that the HTML embedding does not disrupt the overall Markdown structure.

Additional Notes

  • Future enhancements could include responsive image handling and support for additional alignment options if needed.
  • Documentation has been updated to reflect the new image embedding approach.


feat(markdown): add support for image alignment

- Implement alignment options (left, center, right) in Markdown image syntax
- Update Markdown parser to recognize and process alignment directives
- Modify rendering engine to apply appropriate CSS classes based on alignment
- Enhance documentation with usage examples for image alignment
- Add tests to verify alignment functionality works as expected
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