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

Prettier #118

Merged
merged 22 commits into from
Jun 20, 2024
Merged

Prettier #118

merged 22 commits into from
Jun 20, 2024

Conversation

glenn-jocher
Copy link
Member

@glenn-jocher glenn-jocher commented Jun 20, 2024

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Updating the GitHub Action workflow to improve markdown handling and Prettier integration.

πŸ“Š Key Changes

  • Removed specific mdformat commands from pip install and markdown processing sections.
  • Adjusted the conditions for running Prettier to also consider markdown inputs.
  • Updated Prettier to format markdown files with a tab width of 4 for compatibility with MkDocs.
  • Added a new step to update unordered Markdown list indents for MkDocs compatibility.

🎯 Purpose & Impact

  • Streamlined Workflow: Simplifies the workflow by removing redundant Markdown formatting steps.
  • Improved Compatibility: Ensures Markdown files are formatted correctly for MkDocs, enhancing documentation consistency.
  • Broader Formatting Scope: Expands Prettier's use to markdown files, maintaining code consistency across various file types.
  • User Convenience: Makes it easier for contributors to maintain the project's documentation style without manual adjustments.

@glenn-jocher glenn-jocher merged commit f15a90f into main Jun 20, 2024
3 checks passed
@glenn-jocher glenn-jocher deleted the prettier branch June 20, 2024 16:24
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