Add a .markdownlintrc config file for Markdown file linter#1011
Merged
Conversation
Add a config for `markdownlint` that tries to stay close to TensorFlow's documentation style and Google's Markdown Style Guide.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces a .markdownlintrc configuration file to enforce a consistent style for Markdown documents, aligning with TensorFlow and Google style guides. The configuration is well-structured and documented with comments. However, the use of comments in a .markdownlintrc file will cause parsing errors with markdownlint-cli, as it expects a standard JSON format. My review includes a suggestion to remove the comments to make the file valid.
mhucka
added
area/docs
MichaelBroughton
approved these changes
Apr 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In preparation for more work on documentation, and to help contributors get the formatting right, this adds a config file for the program
markdownlintthat tries to stay close to TensorFlow's documentation style and Google's Markdown Style Guide.Note: there is currently no script to run
markdownlintor checks in CI. Those can come later. This config file nevertheless helps people get the right settings in their editors and makes it possible to use a markdownlint pre-commit hook for git.