Add markdownlint with pre-commit

[jbampton]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @jbampton, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces markdownlint into the project's development workflow by integrating it as a pre-commit hook. The primary goal is to automate the enforcement of consistent Markdown formatting and style, thereby enhancing the readability and maintainability of all Markdown documentation. A custom configuration file is included to tailor the linting rules to the project's specific needs, and existing Markdown files have been updated to comply with these new standards.

Highlights

• New Markdown Linter Configuration: A new configuration file for markdownlint has been added at .github/linters/.markdown-lint.yml. This configuration explicitly disables the MD013 (line-length) and MD033 (no-inline-html) rules, allowing for more flexibility in Markdown content while still leveraging other linting benefits.
• Pre-commit Hook Integration: The markdownlint-cli tool has been integrated into the pre-commit configuration. This means that Markdown files (.md$) will now be automatically checked for style and formatting issues using the defined .markdown-lint.yml configuration before commits are allowed, ensuring consistent Markdown quality across the project.
• README.md Formatting Improvements: Minor formatting adjustments have been applied to README.md to improve readability and adhere to better Markdown practices. These changes include adding blank lines around code blocks and specifying the language for code blocks (e.g., shell, text) for enhanced syntax highlighting.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[deepsource-io]

Here's the code health analysis summary for commits b3ae2aa..2a43093. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Secrets	✅ Success		View Check ↗
Python	✅ Success		View Check ↗
JavaScript	✅ Success		View Check ↗

---

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

[gemini-code-assist]

Code Review

This pull request integrates markdownlint into the project's pre-commit hooks to enforce Markdown style guidelines. This was achieved by adding a new .github/linters/.markdown-lint.yml file that disables specific rules (MD013 for line-length and MD033 for no-inline-html) and updating the .pre-commit-config.yaml to include the markdownlint hook, configured to use the new .markdown-lint.yml file. Additionally, the README.md file was modified to improve readability by adding blank lines around code blocks and specifying syntax highlighting (e.g., shell, text) for various code examples.